Intake24

Appearance

Getting started ​

Dev instance ​

Steps to getting a local instance running

  • Setup the database
    • Method 1 (prefered): Execute Docker compose file docker/docker-compose.yml to prepare PostgresQL and Redis instances, and map out port 5432 and 6379 respectively by default.
    • Method 2: Run Dev VM (download from S3 bucket - contact the Intake24 team), which maps out the database on 192.168.56.10:5432 (PostgreSQL). Start this VM.
  • Obtain up-to-date database snapshots from the intake24 team and import them into a database by scripts or DB tools (e.g. DBeaver). Please check the guidance on importing database snapshots with DBeaver.
  • Local servers need to be run for api, admin and survey from each respective folder:
  • To start api / admin / survey: pnpm dev for live reloads

Useful tools ​

  • IDE for developing Node, Typescript, npm (Intake24 use pnpm as drop-in replacement of npm) and associated tooling (e.g. VS Code)
  • Docker, a clean and resource-efficient way to run PostgreSQL and Redis servers locally.
  • Virtual Box (v6.x minimum) for running database VM
  • Database browser (e.g. DBeaver) for exploring/manipulating PostgreSQL DB.
  • Redis

TIP

Intake24 requires node.js version 16 or newer, please make sure to check your node.js version before continuing.

Clone the Intake24 version 4 repository on GitHub.

Follow the readme instructions in the root of the repository.

Databases ​

Please contact the intake24 team for the latest development virtual machine. Please also check the guidance on using the development virtual machine. Alternatively, obtain database snapshots from the intake24 team and import them into a database browser (e.g. DBeaver). Please check the guidance on importing database snapshots with DBeaver. While using the database snapshots, don't forget to set up your own Redis instance.

To install PostgresQL and Redis instanace using provided setup, go to docker folder to start containers in the background by:

bash
docker compose up -d

TIP

The script also run DB script within docker/init folder, hence if you may need to grant execution right for the scripts inside this folder.

Please also check the guideline to configure or import database snapshot to PostgreSQL server created using docker.

API server ​

Go to api and follow instructions in the readme file.

Copy the .env-template file to .env and change the following settings:

  • JWT_ACCESS_SECRET — set to any string (security doesn't matter for development purposes), e.g. verybigsecret,
  • JWT_REFRESH_SECRET — same as above but use a different secret,
  • DB_CONNECTION_SSL - set to false for if the instance is for development purpose
  • DB_SYSTEM_HOST — set to 192.168.56.4 if using the development VM or alternatively point to your own database instance,
  • DB_SYSTEM_PORT, DB_SYSTEM_USERNAME, DB_SYSTEM_PASSWORD — keep the default settings if using the VM or edit according to your own DB settings,
  • DB_FOODS_HOST — set to 192.168.56.4 if using the development VM or alternatively point to your own database instance,
  • DB_FOODS_PORT, DB_FOODS_USERNAME, DB_FOODS_PASSWORD — keep the default settings if using the VM or edit according to your own DB settings,
  • QUEUE_REDIS_HOST — set to 192.168.56.4 if using the development VM or alternatively point to your own Redis instance.
  • APP_SECRET - secret used to generate and verify admin logins. Please use a different secret.
  • DB_DEV_SYSTEM_URL and DB_DEV_FOODS_URL - set the connection strings according to your VM 192.168.56.4, or alternatively point to your own database instance. If you are using docker compose script provided, PostgresQL DB will be installed locally, using default port 5432, user name postgres and password postgres. The connection string will become something like postgres://postgres:postgres@localhost:5432/{intake24 DB name}
  • WEBPUSH_PUBLIC_KEY and WEBPUSH_PRIVATE_KEY - check out API server configuration to generate key pairs.

Check that the settings are correct by starting the server with pnpm dev.

TIP

Add DB_DEV_SYSTEM_DEBUG_QUERY_LIMIT=500 and DB_DEV_FOODS_DEBUG_QUERY_LIMIT=500 to the API .env file to limit debug query char limit. It can prevent long queries from cluttering the console. The API server runs food indexing each time it starts so the console outputs can be quite a lot. The server does that for all locales in the food database, so for the DEV instance, you can also limit number of locales it runs against in .env by setting APP_ENABLED_LOCALES = ["UK_V2_2022"].

API access ​

If you had your account already created in the databse snapshot you are using, please add your email in DBeaver users tables, then go to apps/cli, and run pnpm cli:dev hash-password yourNewPassword.

Grab the hash and put it manually into the password_hash column of the user_passwords table for your user record (find you user_id in users). There will be a cli command available to create a whole new account without this manual hassle.