akademik API

This application is REST API for faculty portal application. It uses NestJS framework with Typescript.

Prerequisites

In order to run this application you need to install:

• Node.js
• PostgreSQL database

Installation

To install all needed packages run:

$ npm install

Application parameters

In order to function properly this application needs some environment variables to be set.

Create .env file in project root directory and set those variables. You can see how that file is supposed to look like in .env.example.

Development

To populate database with dummy data for testing purposes run:

$ npm run db:seed

This will populate database and create random users.

These users will be generated every time:

• admin with email admin@akademik.com and password admin
• student with email student@akademik.com and password password
• professor with email professor@akademik.com and password password

All other users have password password (their emails are random).

Note: Please run seeder only on empty database.

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# debug mode
$ npm run start:debug

# production mode
$ npm run start:prod

Swagger

When application is running swagger documentation will be available at /api route.