KYCnot.me

KYCnot.me

Development

Installations

Install the following tools:

• nvm (or node)
• docker
• just

Initialization

Run this the first time you setup the project:

# you can alternatively use `just dev-database`
docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d --wait database redis
cd web
nvm install
npm i
cp -n .env.example .env
npm run db-reset

Now open the .env file and fill in the missing values.

Default users are created with tokens: admin, moderator, verified, normal (configurable via env vars)

Running the project

In separate terminals, run the following commands:

• Database

  # you can alternatively use `just dev-database`
  docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d --wait database redis
  

• Website http://localhost:4321

  cd web
  nvm use
  npm run dev
  

• Database Admin (Optional) http://localhost:5555

  cd web
  nvm use
  npm run db-admin
  

Tip

VS Code will run the project in development mode automatically when you open the project.