Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hackthevalley/hack-the-back
A Hackathon event platform to elegantly handle Hacker apps, with ready-made GraphQL and REST endpoints :sunglasses:
https://github.com/hackthevalley/hack-the-back
competition django-project hackathon hackathon-application registration
Last synced: 3 days ago
JSON representation
A Hackathon event platform to elegantly handle Hacker apps, with ready-made GraphQL and REST endpoints :sunglasses:
- Host: GitHub
- URL: https://github.com/hackthevalley/hack-the-back
- Owner: hackthevalley
- License: mit
- Created: 2020-10-09T22:42:30.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-04T05:14:40.000Z (4 months ago)
- Last Synced: 2024-12-11T05:10:53.647Z (about 2 months ago)
- Topics: competition, django-project, hackathon, hackathon-application, registration
- Language: Python
- Homepage:
- Size: 313 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hackathon - Hack the Back - An elegant backend, with ready-made GraphQL and REST endpoints. (Platforms / Open Source 🌳)
README
Hack the Back
An elegant backend for Hackathons
A Hackathon event platform to elegantly handle Hacker apps, with ready-made GraphQL and REST endpoints.
## Table of Contents
- [Installation](#Installation)
- [Schema Documentation](#Schema-Documentation)
- [Contributing](#Contributing)
- [License](#License)
## Installation
Hack the Back requires [Python 3.8](https://www.python.org/downloads/release/python-386/), and [PostgreSQL](https://www.postgresql.org/) at minimum, to run in real-world production environments.
Please view production installation instructions on the [Wiki page](https://github.com/hackthevalley/hack-the-back/wiki/Installation).
## Schema Documentation
Hack the Back provides both GraphQL and REST APIs for use by the client.
### GraphQL Documentation
This project uses [Graphene](https://graphene-python.org/) with [Django Rest Framework](https://www.django-rest-framework.org) serializers in order to build the GraphQL API. Every GraphQL server has an introspection system and Graphene is no different. To view the schema from this system, the GraphQL playground is included:
- **Playground:** [/api/graphql](http://localhost:8000/api/graphql)
#### Download the Schema via the CLI
```bash
./manage.py graphql_schema --schema hacktheback.graphql.schema.schema --out graphql-schema.json
```
_Make sure to load environment variables `SECRET_KEY` and `DEBUG` before running the command above._
### REST Documentation
This project uses [drf-spectacular](https://github.com/tfranzel/drf-spectacular) to automatically generate an OpenAPI 3.0 schema for the REST API that is built with the [Django Rest Framework](https://www.django-rest-framework.org).
- **Swagger UI:** [/api/swagger](http://localhost:8000/api/swagger)
- **OpenAPI Schema** (yaml)**:** [/api/schema.yaml](http://localhost:8000/api/schema.yaml)
- **OpenAPI Schema** (json)**:** [/api/schema.json](http://localhost:8000/api/schema.json)
- **OpenAPI Schema** (via content negotiation)**:** [/api/schema](http://localhost:8000/api/schema)
#### Download the Schema via the CLI
```
./manage.py spectacular --file openapi-schema.yml
```
_Make sure to load environment variables `SECRET_KEY` and `DEBUG` before running the command above._
_**Fun fact:** You can take advantage of this project's OpenAPI 3.0 Schema to do [automatic code generation](https://openapi-generator.tech/) for the client or server. In other words, you can generate SDKs for a client library or framework — such as Angular. Alternatively, you can generate some starter code in another back-end web framework with the same REST endpoints._ :thinking:
## Contributing
Hack the Back requires contributors to install [Python 3.8](https://www.python.org/downloads/release/python-386/) and [Poetry](https://python-poetry.org/) at minimum, to run in a development environment. The database in the development environment uses the SQLite engine, which stores data in an SQLite file in the root directory.
Please view the [Contributing Wiki pages](https://github.com/hackthevalley/hack-the-back/wiki/How-to-Contribute) for more details on installation and best practices.
## License
Everything in this repository is under the [MIT License](./LICENSE). Please carefully read and comply with the [license](./LICENSE) agreement.
**Created with :heart:  by [Hack the Valley](https://hackthevalley.io/).**
---
