https://github.com/neelkamath/backend-prototype
⏩ Template for backend prototypes
https://github.com/neelkamath/backend-prototype
backend docker gradle kotlin ktor mlab mongodb ngrok openapi template
Last synced: about 2 months ago
JSON representation
⏩ Template for backend prototypes
- Host: GitHub
- URL: https://github.com/neelkamath/backend-prototype
- Owner: neelkamath
- License: mit
- Created: 2020-03-02T11:10:02.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-13T13:31:28.000Z (almost 6 years ago)
- Last Synced: 2025-01-18T12:29:22.357Z (about 1 year ago)
- Topics: backend, docker, gradle, kotlin, ktor, mlab, mongodb, ngrok, openapi, template
- Language: Kotlin
- Size: 1.17 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Backend Prototype
_Quick reliable backend prototypes_
For backend developers who need to build a prototype, this project is a template that provides boilerplate for the required technologies. Unlike other templates, this project provides the best technologies for prototyping modern applications.
To know why particular technologies were chosen, read the [explanation](docs/explanation.md).
It is best for prototypes to use HTTP GET requests due to innumerable problems which arise which from attempting to use other HTTP methods like POST. If you're using this template for a hackathon, feel free to set up your project prior to the event. Setting up non-program assets such as CI/CD pipelines isn't against the rules. You might want to create a separate repository to host the specification(s) such as the frontend's wireframes, the application's objectives, the OpenAPI specification, etc. In that case, remove the OpenAPI parts of this repo.
Follow the **Contributing** section if you are using this template (building the HTTP API; the backend developer) to create an application. Follow the **Installation** and **Usage** sections if you are using the application (consuming the HTTP API; the frontend developer) that was built with this template.
## Installation
1. Install the [dependencies](docs/dependencies.md).
1. Optionally, generate a client SDK for the HTTP API using [OpenAPI Generator](https://openapi-generator.tech/) on the file https://raw.githubusercontent.com/neelkamath/backend-prototype/master/docs/openapi.yaml.
## Usage
### [Documentation](https://neelkamath.gitlab.io/backend-prototype/)
### [Running the Server](docs/production.md)
## [Contributing](docs/CONTRIBUTING.md)
## License
This project is under the [MIT License](LICENSE).