Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chromesd22159/hochrheinshoppingapi

Hochrhein Shopping Api
https://github.com/chromesd22159/hochrheinshoppingapi

api-rest kotlin kotlindl ktor-client ktor-server mysql

Last synced: 9 days ago
JSON representation

Hochrhein Shopping Api

Awesome Lists containing this project

README

        

# Welcome to Hochrhein Shopping Api!

This project is based on Ktor, a lightweight framework for building web applications in Kotlin.

## Setup Instructions:

1. **Create Required Files**:
- Create a `version.txt` file in the root directory.
- Create a `.env` file with the following parameters:
```
DB_PORT=
DB_NAME=
DB_HOST=
DB_USERNAME=
DB_PASSWORD=

EXCHANGE =
WEATHER =
ROUTE =
```

## Deployment
### Server Services:

The Hochrhein Shopping API is managed as a service with the following configuration:
```
[Unit]
Description=hochrheinshopping.service
After=network.target
StartLimitIntervalSec=10
StartLimitBurst=5

[Service]
Type=simple
Restart=always
RestartSec=1
User=root
EnvironmentFile=/etc/environment
ExecStart=/usr/lib/jvm/default-java/bin/java -jar /var/www/vhosts///fat.jar
```

#### Start Service:
- This command starts the hochrheinshopping service, allowing the Hochrhein Shopping API to run.
#### Check Service Status:
- This command checks the status of the hochrheinshopping service, indicating whether it is running or not.
#### Stop Service:
- This command stops the hochrheinshopping service, halting the execution of the Hochrhein Shopping API.
#### Enable Service at Boot:
- This command enables the hochrheinshopping service to start automatically when the system boots up.

### [Ktor deploy steps](https://gist.github.com/philipplackner/bbb3581502b77edfd2b71b7e3f7b18bd)

Thank you for using my Ktor project! If you have any questions or need assistance, feel free to reach out.