/howdypix

Manage your gallery

Primary LanguageTypeScript

HowdyPix

Display your photos in a gallery from your personal server. No cloud. Keep your privacy.

Organization

  • apps/ contains the node applications.
  • libs/ contains the shared code that will be used by the apps / other libs.
  • services/ contains the extra services that are required to run the apps. They are not developed by HowdyPix.

Development

  1. Make sure to have docker, docker-compose, node and yarn installed on your machine.

  2. Install the dependencies.

    yarn

  3. Start the dev process.

    yarn dev

    This command will watch on any file change in the apps and libs directory, and restart the node processes.

The previous command is useful to start everything, but it's more efficient to start processes separately to save time. For example, we rarely need to restart the RabbitMQ docker container. Here are the available commands:

yarn dev:libs      # Starts and watches the libs directory
yarn dev:services  # Starts and watches the services directory
yarn dev:apps      # Starts and watches the apps directory

You generally run the dev:libs and dev:services once, and restart many times dev:apps.

Code quality

  1. Tests are mandatory for the most part of the application.
  2. Typescript has the strict option to enable better typing.