This is the backend for the schmell application and admin panel. It is written in Kotlin and uses the Spring Boot framework. All logic is handled by the backend, the frontend is only used to display the data.
- Kotlin
- Spring Boot
- Spring Security
- Spring Data JPA
- AWS S3
- SendGrid
- PostgreSQL
- Auth0
- Docker
- Java 11
- Docker
- Docker Compose
- Gradle
- An IDE (IntelliJ IDEA recommended)
- Postman (optional)
- PostgreSQL (optional)
We use a PostgreSQL database for local development. You can either install PostgreSQL locally or use Docker to run a container with PostgreSQL.
To run a container with PostgreSQL, run the following command in the root directory of the project:
docker-compose up -d
-
Clone the repository:
git clone https://github.com/schmell-app/backend.git
-
Create an
application.yml
file in thesrc/main/resources
directory. The file should contain all the properties listed in theapplication-sample.yml
file in the root directory. -
Install necessary dependencies with Gradle:
./gradlew build
-
Run the project:
./gradlew bootRun
The project should now be running on localhost:8080
This work is licensed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. See LICENSE
for more information.