Icebreaker Backend
This repository contains the code for the backend server of icebreaker.science.
Development
The default port is 9090. Open http://localhost:9090 to find a welcome message and navigate to http://localhost:9090/swagger-ui/ for the Swagger UI.
Requirements
- Java 14+
Database
The schema of the database is stored in database/init.sql. A docker-compose file is in the same directory providing a simple solution to initialize a database.
Application Properties
The (default values of the) application properties are stored in src/main/resources/application.properties. There are various ways to overwrite them, including using environment variables. Read the Spring documentation for details.
Development Mode
The development mode allows cross-origin requests (CORS) and may return more details about exceptions. To enable it, the application property icebreaker.development needs to be true. A way to do it is to set the environment variable ICEBREAKER_DEVELOPMENT to true.
Testing
./gradlew clean test
Please ensure that the tests are run against a newly initiated database.
Test methods' names should follow this pattern: MethodName_StateUnderTest_ExpectedBehavior.