feat: Add APIs (#2)

* add: Map, Match and Game Api * add: RabbitMQ to CI * add: leaderboard, user, notification APIs * fix: Update to latest API spec * add: Instructions in README * add: Map validator * fix: Move to assert4j * add: Instruction for docker setup Co-authored-by: Dipesh Kafle <[email protected]>
delta · Feb 14, 2022 · 1e7373b · 1e7373b
1 parent dee8f88
commit 1e7373b
Show file tree

Hide file tree

Showing 97 changed files with 3,464 additions and 190 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -43,6 +43,11 @@ jobs:
   test:
     runs-on: ubuntu-latest
     needs: build
+    services:
+      rabbitmq:
+        image: rabbitmq:3-management
+        ports:
+          - 5672:5672
     steps:
       - uses: actions/checkout@v2
       - name: Set up JDK 17

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -7,6 +7,11 @@ on:
 jobs:
   deploy:
     runs-on: ubuntu-latest
+    services:
+      rabbitmq:
+        image: rabbitmq:3-management
+        ports:
+          - 5672:5672
     steps:
       - uses: actions/checkout@v2
       - name: Set up JDK 17

diff --git a/.runConfigurations/DB.run.xml b/.runConfigurations/DB.run.xml
@@ -1,12 +1,13 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="DB" type="docker-deploy" factoryName="docker-compose.yml" server-name="Docker">
+  <configuration default="false" name="DB &amp; RabbitMQ" type="docker-deploy" factoryName="docker-compose.yml" server-name="Docker">
     <deployment type="docker-compose.yml">
       <settings>
         <option name="buildKitEnabledForCompose" value="true" />
         <option name="envFilePath" value="" />
         <option name="services">
           <list>
             <option value="db" />
+            <option value="rabbitmq" />
           </list>
         </option>
         <option name="sourceFilePath" value="docker-compose.dev.yml" />

diff --git a/.runConfigurations/Format.run.xml b/.runConfigurations/Format.run.xml
@@ -4,7 +4,7 @@
       <option name="executionName" />
       <option name="externalProjectPath" value="$PROJECT_DIR$" />
       <option name="externalSystemIdString" value="GRADLE" />
-      <option name="scriptParameters" value="" />
+      <option name="scriptParameters" value="--info" />
       <option name="taskDescriptions">
         <list />
       </option>

diff --git a/README.md b/README.md
@@ -12,7 +12,26 @@
   </a>
 </p>
 
+### Prerequisites
+1. JDK 17 (Ubuntu: install the `openjdk-17-jdk` package)
+2. [Intellij IDEA Ultimate](https://www.jetbrains.com/idea/download/#section=linux)
+3. Docker
+
 ### Setup
 
-1. Copy server/src/main/resources/application.example.yml to server/src/main/resources/application.yml.
-2. Run `./gradlew tasks` to see the tasks available.
+1. Clone the repo and open in IntelliJ Ultimate.
+2. Press `Ctrl+Alt+Shift+S` and make sure the JDK version is 17.
+3. Press `Ctrl+Alt+S` and go to `Build, Execution, Deployment -> Docker` and make sure docker is configured correctly/
+4. 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`.
+5. The run configurations will be available in the top bar:
+   ![Run Configurations](https://i.imgur.com/pO2SrPd.png)
+
+### 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)