CodeCharacter Server 2024

Prerequisites

1. JDK 17 (Ubuntu: install the openjdk-17-jdk package)
2. Intellij IDEA Ultimate
3. Docker

Setup

1. Clone the repo and open in IntelliJ Ultimate.

2. From the project root directory,run ./gradlew installGitHooks to install git-hooks

3. Press Ctrl+Alt+Shift+S and make sure the JDK version is 17.

4. Press Ctrl+Alt+S and go to Build, Execution, Deployment -> Docker and make sure docker is configured correctly/

5. Copy server/src/main/resources/application.example.yml to server/src/main/resources/application.yml. If you want to use docker instead, copy the server/src/main/resources/application.docker.example.yml to server/src/main/resources/application.yml.

6. Run git submodule update --init

7. Run cp server/src/main/resources/dcConstants.example.json server/src/main/resources/dcConstants.json

8. The run configurations will be available in the top bar:

   

Run Configurations

1. DB & RabbitMQ: For starting the MongoDB and RabbitMQ containers.
2. Dev: To start the docker development server.
3. Production: To start the docker production server.
4. Tests: To run the tests.
5. Format: To format the project.
6. Assemble: To assemble the project binary.
7. Server: To start the server. (Might require DB & RabbitMQ to be running)