• We are team of passionated software developers and we have our own git management guideline, visit our Git guideline
• Conventional Commits are welcome
• We use Github for TMS purpose as well, here is our automated board

• Swagger on staging server

• Git Doc

• OpenAPI document is available on /doc

• Deployment

• PostgreSQL
• Node.js
• Nest.js

Make a copy of .env.example.

$ cp .env.example .env

Configure DATABASE_URL in .env file.

DATABASE_URL = postgres:https://[USER_NAME]:[PASSWORD]@[DOMAIN]:[PORT_NUMBER]/[DATABASE_NAME]

DATABASE_URL = postgres:https://root:root@localhost:5432/jobhub

• Run typeorm CLI, see detailed doc here

$ npm run typeorm <additional-commands>

• Create a new migration

$ npm run typeorm:migrate <migration-name> # We recommend to use Pascal Case for migration

• Run migration manually

$ npm run typeorm:run

• Prepare idea-board images.
• Upload ide-board images to AWS S3 bucket.

$ npm run idea-seed -- --directory=</path/to/images/directory> --from=<from-num> --to=<to-num>

• Prepare idea-board data file.
  Store idea-board entries to /project-dir/data/idea-board-data.txt in the following format.
  

<image-number>\t<project-accessory-type>\t<material-type>\n

$ npm install

# run server in watch mode
$ npm run start:dev

# build in production mode
$ npm run start:prod

You can check detailed API documentation from here