This repository has been archived by the owner on Sep 6, 2020. It is now read-only.

This branch is 1 commit ahead of master.

Name	Name	Last commit message	Last commit date
Latest commit snyk-bot fix: requirements.txt to reduce vulnerabilities Jul 29, 2020 c69c41d · Jul 29, 2020 History 123 Commits
.github/workflows	.github/workflows	remove redundant files so it used org defaults	Oct 23, 2019
Utils	Utils	Fix config and default disable update endpoint	Sep 7, 2019
routers	routers	cleanup	Oct 13, 2019
tests	tests	Introduce tests!	Aug 5, 2019
.gitignore	.gitignore	Add multiprocessing for Prometheus	Jul 5, 2019
Bootloader.sh	Bootloader.sh	Add multiprocessing for Prometheus	Jul 5, 2019
LICENSE	LICENSE	Initial commit	May 5, 2019
README.md	README.md	Introduce tests!	Aug 5, 2019
api.py	api.py	add sentry error tracking	Sep 6, 2019
defaultconfig.json	defaultconfig.json	Fix config and default disable update endpoint	Sep 7, 2019
pytest.ini	pytest.ini	Introduce tests!	Aug 5, 2019
requirements.txt	requirements.txt	fix: requirements.txt to reduce vulnerabilities	Jul 29, 2020

Repository files navigation

Gearbot Dashboard API

This repository contains all of the code that powers Gearbot's web dashboard

Contributing

All healthy contributions are appreciated and welcomed. We use Pytest for unit and functional testing to help with keeping bugs from popping up. See pytest.ini on how to run specific tests.

Steps:

Clone the repository with git clone https://github.com/gearbot/Dashboard-api.git
Install the project dependencies with pip -r requirements.txt
Assure your code behaves as expected, add comments where explanations may be needed
Run pytest to make sure the existing tests still succeed
Add any new tests or tweak existing ones to fit new behavior or features
Make sure all tests pass when you are finished