README.md

PenguinMod-BackendApi

This is the replacement for PenguinMod-IntermediateBackendApi.

This is intended to be a major rewrite of the entire API to be organized much better, and use MongoDB & other systems for better scalability.

Contributing

You can create endpoints by adding folders & files. Please make sure your code is easy to read or at least has comments :D

Vulnerabilities

Please report any security vulnerabilities using GitHub's security tab on the repository, or join the PenguinMod discord on the website and DM a developer.

Development

Either setup as you would with prod, or:

1. Install MongoDB
   • Windows
   • Mac
   • Linux
2. Run mongod to start mongodb
3. Run npm i. if this doesn't work run it with --force (if you have to use force, make an issue. We want to avoid having to do that)
4. Install minio and start it
   • Linux
   • Mac
   • Windows
5. Add a .env file copied from the .env.template file and fill in the values.
6. Run npm run dev to start the server in development mode.

Deployment

Make sure your env is setup, then use docker-compose to get the containers running.

Note: Keep your env PRIVATE!! Do NOT put it in a public repo!! Don't even put it in a private one!!