Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 924 Bytes

README.md

File metadata and controls

24 lines (17 loc) · 924 Bytes

Guild Control Panel REST API

Information

This was created purely for educational reasons as an API was required for a university project.

Credits

https://github.com/datamus - Project member

Repository status

This repository was originally hosted privately elsewhere, and certain sensitive information was hardcoded. The history is therefore gone.

Swagger documentation

Documentation of the API can always be viewed while the project is running at HOST:PORT/DOCS. A live example is hosted at https://gcpapi.cxdur.xyz/internal/docs/.

Testing locally

Install dependencies by using npm install and then run npm run start. The server should automatically restart as changes are applied.

Running in production

Install dependencies by using npm install and then run npm run prod.

Running tests

Make sure dependencies are installed, and run tests by using npm test.