Upload API Prep Part 1: Add db-migrate, extract config.ts, change tsoa entrypoint and use tsx in prod

.dockerignore

@@ -8,6 +8,7 @@
 # Useless and heavy folders
 **/build
 **/dist
+data
 [...]
 **/.next
 **/.vercel
@@ -16,4 +17,4 @@
 # Other useless files in the image
 .git/
 .github/
-[...]
+[...]

.env.example

@@ -5,4 +5,6 @@ POSTGRES_PASSWORD=badgehub
 PGADMIN_DEFAULT_PASSWORD=badgehub
 [email protected]
 
-JWT_SIGNING_KEY="!!HackThePlanet!!"
+NODE_ENV=development
+
+JWT_SIGNING_KEY="!!HackThePlanet!!"

Dockerfile

@@ -1,29 +1,23 @@
-# Build Stage
-FROM node:22-bookworm-slim AS build
-
-WORKDIR /home/node/app
-
-COPY package*.json ./
-RUN npm install
-COPY . .
-RUN npm run build
-
-# Prod stage
 FROM node:22-bookworm-slim
 
 WORKDIR /home/node/app
 ENV NODE_ENV=production
 
 # Copy only needed files
-COPY  --chown=node:node --from=build /home/node/app/dist ./dist
-COPY  --chown=node:node --from=build /home/node/app/public ./public
-COPY  --chown=node:node --from=build /home/node/app/package*.json ./
+COPY  --chown=node:node ./package*.json .
 
 RUN npm ci --only=production --ignore-scripts
 
-COPY process.json .
+COPY --chown=node:node process.json .
 RUN mkdir -p /home/node/.pm2 /home/node/app/logs /home/node/app/pids && chown -R node:node /home/node/.pm2 /home/node/app/logs
 
+# db-migrate stuff
+COPY --chown=node:node migrations ./migrations
+COPY --chown=node:node database.json .
+
+COPY --chown=node:node ./public ./public
+COPY --chown=node:node ./src ./src
+
 USER node
 EXPOSE 8081
 CMD ["./node_modules/pm2/bin/pm2-runtime", "process.json"]

README.md

@@ -4,6 +4,50 @@
 
 ## - Development -
 
+### Database Migrations
+
+In order to make sure that we can keep track of the database schema, we use [db-migrate](https://db-migrate.readthedocs.io/en/latest/).
+This allows us to track the database changes along with git and provide a framework for migrating data and rolling back changes.
+So when a change to the database schema is needed, a new migration should be created instead of manually changing the database.
+To create a new migration, follow the steps below.
+
+#### Create a new migration
+
+```bash
+npm run db-migrate:create -- <migration-name>
+```
+
+This will create a new migration file in the `migrations` directory with the name `<timestamp>-<migration-name>.js` as well as 2 sql files, one for the up migration and one for the down migration.
+
+#### Fill in the down and up migration sql files with the necessary changes to the database schema.
+
+These sql commands should take care of changing the database schema as well as migrating the data if necessary.
+
+#### Run the migration to test it.
+
+```bash
+npm run db-migrate:up
+```
+
+#### Create updated mock.sql
+
+For the mock data, we always want up to date tables, so after you have done the migration on the mock data, you should re-export the database.
+You can do this with the pg_dump command in the postgres container:
+
+```bash
+npm run backup
+```
+
+#### Run the down migration to test it.
+
+```bash
+npm run db-migrate:down
+```
+
+#### Commit the migration files to git.
+
+When the code is deployed, the up migrations will be run automatically before starting the server.
+
 ## Install
 
 Make sure [Docker](https://www.docker.com/get-started/) is installed and running.
@@ -99,5 +143,7 @@ docker compose --file docker-compose-production.yml down
 
 - [Express](https://expressjs.com/), a framework for Node.js
 - [tsoa](https://tsoa-community.github.io/docs/) for generating a swagger file from code
+- [sql-template-tag](https://github.com/blakeembrey/sql-template-tag) for more easily writing SQL queries
+- [db-migrate](https://db-migrate.readthedocs.io/en/latest/) for database migrations
 - [tsx](https://tsx.is/) for watching TypeScript files in Node.js
 - [PM2](https://pm2.keymetrics.io/) for managing Node.js processes

database.json

@@ -0,0 +1,12 @@
+{
+  "defaultEnv": "pg-from-env",
+  "pg-from-env": {
+    "driver": "pg",
+    "host": { "ENV": "POSTGRES_HOST" },
+    "database": { "ENV": "POSTGRES_DB" },
+    "user": { "ENV": "POSTGRES_USER" },
+    "password": { "ENV": "POSTGRES_PASSWORD" },
+    "port": "5432",
+    "schema": "badgehub"
+  }
+}

docker-compose-production.yml

@@ -43,4 +43,4 @@ volumes:
 networks:
   badgehub_network:
     name: badgehub_network
-    external: true
+    external: true

migrations/package.json

@@ -0,0 +1,4 @@
+{
+  "description": "This package.json file is picked up by db-migrate and that is needed because the js files generated by db-migrate are commonjs",
+  "type": "commonjs"
+}