Job Quest API

Job Quest API with easy-to-use swagger UI. Frontend Repo

Table of Contents

• Job Quest API
  • Technology Stack
  • Deployment
  • Installation

Technology Stack

1. NestJS with Typescript (framework)
2. PostgreSQL Database (storage)

Deployment

GitHub actions handle app deployment. Deployment configurations can be found in .github/workflows.

Installation

1. Download this repository
2. Run the node version specified in .nvmrc.
   • You could run nvm use if you have nvm installed in your machine.
3. Install dependencies npm install
4. *Provide env variables outlined in src/config.schema
5. Run the app
   • npm run start development
   • npm run start:dev development watch mode
   • npm run start:prod production mode

*You must provide a URL to a running database instance for the DATABASE_URL environment variable. If you already have docker installed in your machine, run docker-compose up db-local to spin up a PostgresSQL container.