Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cryptic-game/java-backend-old

This is the Java Backend of the Cryptic project.
https://github.com/cryptic-game/java-backend-old

api cryptic cryptic-game hacktoberfest hibernate-orm java java-11 netty sql

Last synced: about 1 month ago
JSON representation

This is the Java Backend of the Cryptic project.

Awesome Lists containing this project

README

        


Cryptic Java Backend



Releases


Build




DockerHub - Server


DockerHub - Java Daemon


DockerHub - Admin Panel



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](https://www.jetbrains.com/idea/))
* [JDK 17](https://adoptium.net/)
* [Git](https://git-scm.com/)

### Installing

A step by step series of examples that tell you how to get a development env running

```sh
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:
````sh
./gradlew :server:start
````

Java-Daemon:
````sh
./gradlew :java-daemon:start
````

Admin-Panel:
````sh
./gradlew :admin-panel:start
````

To customize your development environment, check our [available environment variables](https://wiki.cryptic-game.net/books/einf%C3%BChrungen/page/environment).

### Documentation

The Javadocs can be found in [GitHub Pages](https://cryptic-game.github.io/java-backend/) and the protocol documentation in our [wiki](https://wiki.cryptic-game.net/books/einf%C3%BChrungen/chapter/java).

### Deployment

See Cryptic backend deployment. (TODO Link)

## Used Tools

* [Gradle](https://gradle.org/) - The build tool
* [GitHub Actions](https://github.com/features/actions/) - The CI tool
* [Docker](https://docker.com/) - The deployment tool

## Authors

_**The Cryptic Java Team**_