Cryptic Java Backend
This is the Java Backend of the Cryptic project.
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development. See deployment for notes on how to deploy the project on a live system.
Prerequisites
What things you need to install the software and how to install them
- A Java IDE (IntelliJ IDEA)
- JDK 17
- Git
Installing
A step by step series of examples that tell you how to get a development env running
git clone https://github.com/cryptic-game/java-backend.git
Then you can open it with you IDE.
Running
To test the things you have changed you have to execute the Gradle Task 'run'.
Server:
./gradlew :server:start
Java-Daemon:
./gradlew :java-daemon:start
Admin-Panel:
./gradlew :admin-panel:start
To customize your development environment, check our available environment variables.
Documentation
The Javadocs can be found in GitHub Pages and the protocol documentation in our wiki.
Deployment
See Cryptic backend deployment. (TODO Link)
Used Tools
- Gradle - The build tool
- GitHub Actions - The CI tool
- Docker - The deployment tool
Authors
The Cryptic Java Team