https://github.com/aidenwallis/customapi

AidenWallis' customapi resource
https://github.com/aidenwallis/customapi

Last synced: about 6 hours ago
JSON representation

AidenWallis' customapi resource

• Host: GitHub
• URL: https://github.com/aidenwallis/customapi
• Owner: aidenwallis
• Created: 2018-12-26T20:01:50.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T01:43:54.000Z (about 2 years ago)
• Last Synced: 2023-03-06T02:28:26.308Z (almost 2 years ago)
• Language: JavaScript
• Homepage: https://customapi.aidenwallis.co.uk/
• Size: 667 KB
• Stars: 11
• Watchers: 2
• Forks: 3
• Open Issues: 17
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# AidenWallis' customapi resource

- [Documentation repo](https://github.com/aidenwallis/customapi-docs)

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](https://www.docker.com/get-started)

1. Fork and clone the repo

1. Change into the directory, and copy the `config.example.json` file to `config.json` and fill in the missing credentials.

1. Run `docker-compose up -d`

1. 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.

1. Any new endpoints should have a unit test written alongside them.

1. You ensure that the code you write runs within the Docker setup we provide, and that there isn't some weird platform dependency.

1. If you do clone this repo and run a version of this on your own, please link back to this repo.

1. Any new endpoints or behaviour added **must** be reflected in the docs repo (found [here](https://github.com/aidenwallis/customapi-docs)), 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.