Description

Main backend for the ThinkStorm project (API and DB relationships)

Installation

GitHub Authentication Setup

Before installing dependencies, you need to set up GitHub authentication to access the private @think-storm/contracts package:

1. Create a GitHub Personal Access Token (PAT):

   • Go to GitHub.com → Settings → Developer Settings → Personal Access Tokens → Tokens (classic)
   • Click "Generate new token (classic)"
   • Give it a name (e.g., "ThinkStorm Package Access")
   • Select scopes: at minimum, check "read:packages"
   • Click "Generate token"
   • IMPORTANT: Copy the token immediately as you won't be able to see it again

2. Add the token to your environment:

   For Linux/macOS:

   # Add to ~/.bashrc or ~/.zshrc
   echo 'export GITHUB_TOKEN=your_token_here' >> ~/.bashrc
   source ~/.bashrc

   For Windows (PowerShell):

   # Add to PowerShell profile
   Add-Content $PROFILE "`$env:GITHUB_TOKEN='your_token_here'"
   # Reload profile
   . $PROFILE

   For Windows (Command Prompt):

   # Add to system environment variables
   setx GITHUB_TOKEN "your_token_here"

3. Configure npm to use the token:

   # Create or edit .npmrc in your home directory
   echo "//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}" >> ~/.npmrc
   echo "@think-storm:registry=https://npm.pkg.github.com" >> ~/.npmrc

Now you can proceed with the installation:

npm install

# add the pre-commit hook
npm run prepare

First-time running the server locally

You first need to create the db and seed it.

• You need to download postgreSQL and create a database on your local setup.
• You then need to create a .env file with the environment variables from the .env_example and replace the values by the ones that apply for your local configuration.
• Finally you can run the following commands to fill your db with the schema and the seeds.

# generate the db schema up until the latest migration and generates the prisma client
npm run db:migrate

# filling the db with the seeds
npm run db:seed

Running the app

# development
npm run start

# watch mode
npm run start:dev

# production mode
npm run start:prod

Test

# run all tests
npm run test:full

Or you can run them separately:

# run unit tests
npm run test:unit

# run e2e tests
npm run test:e2e

Running Test in a containerized environment

# run all tests
npm run ctest

Options:

• help: Show this help message and exit

Services:

• unit: Run unit tests only
• e2e: Run end-to-end tests only
• cov: Run coverage tests only
• (no argument): Run all tests (unit, e2e, and coverage) in parallel

Examples:

• Builds the image if needed and runs all tests

# run all tests
npm run ctest

• Builds the image if needed and runs unit tests only

# run unit tests
npm run ctest unit

• Builds the image if needed and runs e2e tests only

# run e2e tests
npm run ctest e2e

• Builds the image if needed and runs coverage tests only

# run cov tests
npm run ctest cov

• Builds the image if needed and runs unit and e2e tests only

# run unit and e2e tests
npm run ctest unit e2e