employee-management-app-backend

Course project for Web-sovelluskehitys 2 TX00DZ38-3004 at Metropolia UAS. Backend component.

Setup

Prerequisites:

• Docker and Docker Compose
• (For production: OpenSSL)

cp .env.example .env
cp mongodb.env.example mongodb.env
# Edit any values as necessary

In development, you will need to edit the system's hosts file (/etc/hosts on *nix systems and %SYSTEMROOT%\System32\drivers\etc\hosts) to correctly route traffic to MongoDB containers due to a known limitation of Docker. You can either use the update-hosts convenience scripts in scripts/ (must be run as sudo/administrator), or add the following lines manually using the text editor of your choice:

127.0.0.1 mongodb-primary
127.0.0.1 mongodb-replica

For development:

npm i
docker compose -f docker-compose.development.yml up -d
npm run prisma:up
npm start

Note: The db:init script must be run manually after the database container has fully booted for Prisma to work correctly. This is due to a known limitation of MongoDB where replica sets cannot be initialised with DB init scripts in docker-entrypoint.initdb.d.

For production:

npm i
npm run key:gen
docker compose -f docker-compose.production.yml up -d

Usage

On first boot, a superuser account will automatically be created. The credentials for this user will be outputted to the terminal ONLY. If you lose the superuser credentials, you will need to start over.

Development

Editing the Prisma schemas

When making edits to the Prisma schemas, remember to update the database by running npm run prisma:up. This ensures the database remains in sync with the downstream state.

Routing

The API is structured as follows:

• /api
  • /[version]
    • index.ts: API version zone root (register all subzone route handlers)
    • /[subzone]
      • index.ts: Subzone root (registers all route handlers for the subzone)
      • /routes
        • [route].ts