https://github.com/kacperfaber/codziennemotto_pl_server
🎈 Spring API for CodzienneMotto.pl. Allows you to create a lists of daily quotes, invite users to join your list and schedule quote to specific day 🎈
https://github.com/kacperfaber/codziennemotto_pl_server
cicd daily-quotes kotlin openapi rest-api spring spring-test web-testing
Last synced: 2 months ago
JSON representation
🎈 Spring API for CodzienneMotto.pl. Allows you to create a lists of daily quotes, invite users to join your list and schedule quote to specific day 🎈
- Host: GitHub
- URL: https://github.com/kacperfaber/codziennemotto_pl_server
- Owner: kacperfaber
- Created: 2023-02-11T16:00:12.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-10-10T12:19:53.000Z (over 2 years ago)
- Last Synced: 2023-10-11T16:27:41.122Z (over 2 years ago)
- Topics: cicd, daily-quotes, kotlin, openapi, rest-api, spring, spring-test, web-testing
- Language: Kotlin
- Homepage:
- Size: 673 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: licenses/angus-activation-1.0.0.jar/META-INF/LICENSE.md
Awesome Lists containing this project
README
# CodzienneMotto.pl
API Server, made in **Spring** in ❤ Kotlin 😎😋
**CodzienneMotto.pl** allows you to create a lists of daily quotes, invite users to join your list and schedule quote to specific day
See [cross-platform application](https://www.github.com/kacperfaber/codziennemotto-pl-app)
[](https://github.com/kacperfaber/codziennemotto_pl_server/actions/workflows/build.yml)
## Install
If you want to run my server locally
#### Download last version from github
```shell
git clone https://www.github.com/kacperfaber/codziennemotto_pl_server && cd codziennemotto_pl_server
```
#### Run developer profile locally using gradle
```shell
# Run locally and setup testing database
runDev
# Run locally, but without testing database.
runDevNoTestingDb
```
## Configuration
Configuration file it's generally a .properties file. File name is dynamic and it depends on current profile.
```properties
# ./application.{profile}.properties
# Email Client Settings #
# ===================== #
# mailer.from
# mailer.username
# mailer.password
# mailer.smtp
# mailer.port
# Verification Email Settings #
# =========================== #
# verification_email.subject: Subject of the verification email
# MySQL Database #
# ============== #
# db.url: Must contain database name.
# db.username
# #db.password
# Security #
# ======== #
# cors.allow-origin: Access-Control-Allow-Origin header with this value will be added to each response.
# token_hasher.secret: Will encode/decode access tokens using this secret (using AES algorithm)
# password_encoder.secret: Will encode and compare user passwords using PBKDF2 algorithm
# Optional #
# ======== #
# testing.initdb (bool): Only when profile is not production, if it's production won't be called.
# Will generate random database for testing.
```
## See API docs
Swagger UI is here
```http request
/swagger-ui/index.html
```
## Author
Kacper Faber