Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/knighthacks/hackathon-2021-backend
The backend api for Knight Hacks.
https://github.com/knighthacks/hackathon-2021-backend
Last synced: 6 days ago
JSON representation
The backend api for Knight Hacks.
- Host: GitHub
- URL: https://github.com/knighthacks/hackathon-2021-backend
- Owner: KnightHacks
- License: mit
- Created: 2021-05-14T23:15:25.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-05-22T01:12:58.000Z (over 1 year ago)
- Last Synced: 2024-05-29T17:14:29.474Z (6 months ago)
- Language: Python
- Homepage: https://api.knighthacks.org/apidocs/
- Size: 8.19 MB
- Stars: 4
- Watchers: 2
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Knight Hacks 2021 Backend
Backend server for Knight Hacks '21
## Contents
- [QuickStart](#quickstart)
- [Backend Environment Variables](#backend-environment-variables)
- [Testing](#testing)
## QuickStart
**Requirements:**
- MongoDB Server
- Python 3.9
1. Install the requirements. It is suggested that you use a Python virtual environment.
`pip install -r requirements.txt`
2. Run the server
`python -m src run --port=5000`
3. Access Swagger API Documentation
Type `localhost:5000/apidocs` in your browser
## Backend Environment Variables
These are the default values, feel free to change them.
```
APP_SETTINGS=src.config.ProductionConfig
MONGO_URI=mongo://localhost:27017/test
```
## Testing
1. Install the dev requirements.
`pip install -r requirements-dev.txt`
2. Run the tests
`python -m src test`
## Contributing
For guidance on setting up a development environment and how to make a contribution, see the [contributing guidelines](./CONTRIBUTING.md)
## Links
- Website: [https://knighthacks.org](https://knighthacks.org)
- LinkTree: [https://knighthacks.org/linktree](https://knighthacks.org/linktree)
- Discord: [https://discord.gg/Kv5g9vf](https://discord.gg/Kv5g9vf)
- Instagram: [https://www.instagram.com/knighthacks/](https://www.instagram.com/knighthacks/)
- Facebook: [https://www.facebook.com/KnightHacks/](https://www.facebook.com/KnightHacks/)
- Twitter: [https://twitter.com/KnightHacks/](https://twitter.com/KnightHacks/)
- Linkedin: [https://www.linkedin.com/company/knight-hacks/](https://www.linkedin.com/company/knight-hacks/)
- TikTok: [https://www.tiktok.com/@knight.hacks](https://www.tiktok.com/@knight.hacks)