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 🎈

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

Install

If you want to run my server locally

Download last version from github

git clone https://www.github.com/kacperfaber/codziennemotto_pl_server && cd codziennemotto_pl_server

Run developer profile locally using gradle

# 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.

# ./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

/swagger-ui/index.html

Author

Kacper Faber