The REST API backend server for the Jalgaon CoHelp application. Built with Kotlin Ktor.
The REST API backend server for the Jalgaon CoHelp application.
It is a multi-module gradle project and includes below modules.
core
: Core Business Logicport:db
Single source of truth (data)api
: Exposes public APIsmigration
: Handles database migrations and controlThere's a main application module:
application
: This is a main module from where application is executed. It includes app configuration, management and Dependency Injection Bindings.jalgaoncohelp_dev
.export SECRET_KEY=ANY_RANDOM_SECRET
export DATABASE_NAME=jalgaoncohelp_dev
export DATABASE_HOST=localhost
export DATABASE_PORT=5432
export DATABASE_USER=postgres
export DATABASE_PASSWORD=postgres
export JWT_AUDIENCE=JWT_AUDIENCE
export JWT_ISSUER=JWT_ISSUER
./gradlew :application:run
OR
Use IntelliJβs run configuration to run the API server application.
http://localhost:8080
.Awesome! If you want to contribute to this project, you're always welcome! See Contributing Guidelines.
Have any questions, doubts or want to present your opinions, views? You're always welcome. You can start discussions.
You can navigate to /http and try API calls in IntelliJ Idea IDE itself after API is running.
MIT License
Copyright (c) 2021 Jalgaon CoHelp
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.