Web API Development Back End for Trading License Department

Backend of 6003CEM Module.

GitHub -> https://github.coventry.ac.uk/6003CEM-2021JANMAY/Node-Api-BackEnd Codio ->  https://animal-hello-3000.codio-box.uk/api/v1/

Frontend of 6003CEM Module.

GitHub -> https://github.coventry.ac.uk/6003CEM-2021JANMAY/React-JS-FrontEnd Codio -> https://chapter-finish-3000.codio-box.uk/

Frameworks and tools

This is a Koa-based RESTful API for a Trading License Department website developed in Codio.
This API includes User Account registration and login, roles for different users (admins or normal users), applications can be added by normal users and their status can be updated by the admins. MySQL was used for setting up database of the website and all dependencies are available in the package.json file.

Setup

To install all of the required packages navigate to the route folder of this project and run the following command: npm install.

Running the project

To run the project navigate to the route folder of this project and run the following command: nodemon start.

Admin account details to access certain functionalities:

username: andre password: 12345

Running the tests

To run the tests navigate to the route folder of this project and run the following command: npm test.

Documentation

The documentation can be found in the route of this project in the folder docs.

OpenAPI -> https://animal-hello.codio-box.uk/resit-deferral-submission/docs/openapi/index.html

JSDoc -> https://animal-hello.codio-box.uk/resit-deferral-submission/docs/jsdocs/index.html