Skip to content
This repository has been archived by the owner on Jul 31, 2022. It is now read-only.

Latest commit

 

History

History
62 lines (41 loc) · 1.89 KB

README.md

File metadata and controls

62 lines (41 loc) · 1.89 KB
Raw

ExamAdmin Backend

Build with NestJS - a progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular.

Description

This backend was build for easy management and contribution of martial arts clubs. It supports different martial arts from different styles, multible clubs and even umbrella associations. Every user can be part of multible clubs and umbrella associations and can have multible martial arts assigned.

A graphQL api is provided.

Requirements

  • A NoSQL Database - mongodb is recommended (A local mongodb instance for development is recommended)
  • A working email account for sending emails to users (I use mailslurper for development)

Installation

$ npm install
  • Go to the project root folder and open "Config.ts" file
  • Change the values to your needs.
  • Please change JWT_SECRET in Config.ts bevore production deployment!
  • To get the e2e test to work, you need to create a test user manually first!

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests (currently no unit test included)
$ npm run test

# e2e tests (you should run this to see, if everything works)
$ npm run test:e2e

# test coverage
$ npm run test:cov

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

License

Nest is MIT licensed.