kyroskoh / customapi

AidenWallis' customapi resource

AidenWallis' customapi resource

• Documentation repo

A collection of useful customapi endpoints to make more interesting chat commands. Written in NodeJS, runs in Docker, with mongodb and redis.

I am working on writing more tests in the future, we only have a few basic ones right now.

Development Setup

In order to setup your computer for development, please do the following:

1. You will need to install Docker. You can obtain docker by going here
2. Fork and clone the repo
3. Change into the directory, and copy the config.example.json file to config.json and fill in the missing credentials.
4. Run docker-compose up -d
5. The website should be available on localhost:8881.

Development guidelines

1. If you're writing new endpoints, please use the linting rules to ensure that you keep your code clean and consistent.
2. Any new endpoints should have a unit test written alongside them.
3. You ensure that the code you write runs within the Docker setup we provide, and that there isn't some weird platform dependency.
4. If you do clone this repo and run a version of this on your own, please link back to this repo.
5. Any new endpoints or behaviour added must be reflected in the docs repo (found here), please link to the pull request you made on the docs repo whenever you PR a feature, so we can check it out. This project has huge emphasis on documentation.