Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/silverbackhq/Reindeer

🧬 Reactive Applications Boilerplate in Java.
https://github.com/silverbackhq/Reindeer

clivern microservice reactive reindeer rest-api silverbackhq vertx

Last synced: 1 day ago
JSON representation

🧬 Reactive Applications Boilerplate in Java.

Host: GitHub
URL: https://github.com/silverbackhq/Reindeer
Owner: silverbackhq
License: apache-2.0
Created: 2019-11-05T10:17:24.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-11-07T12:01:32.000Z (3 days ago)
Last Synced: 2024-11-07T13:17:53.233Z (3 days ago)
Topics: clivern, microservice, reactive, reindeer, rest-api, silverbackhq, vertx
Language: Java
Homepage:
Size: 391 KB
Stars: 3
Watchers: 2
Forks: 1
Open Issues: 6
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

Reindeer

Reactive Applications Boilerplate in Java.

This project is mainly for personal & testing purposes but you can simply fork or use it as a template.

## Documentation

### Development:

Reindeer built on a top of [vert.x](https://vertx.io/) and uses [gradle](https://gradle.org/) as a build tool. In order to get started, you need to clone the repository and create a config file.

```bash
$ git clone https://github.com/silverbackhq/Reindeer.git
$ cp .env.example .env
```

Then define your custom configs

```env
APP_NAME=Reindeer
APP_KEY=
APP_DEBUG=true
APP_URL=http://localhost
APP_PORT=8000

APP_AUTH_TOKEN=

DB_CONNECTION=h2
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=./storage/db
DB_USERNAME=root
DB_PASSWORD=secret

APP_TIMEZONE=UTC
APP_LANGUAGE=en-us

APP_LOGGING_HANDLERS=console
APP_LOGGING_LEVEL=debug
APP_LOGGING_FORMAT={date} [{level}] {class}.{method}() {message}

REINDEER_LOAD_FROM=config
```

And then migrate & run the application.

```bash
# Provide the path to .env file & Run the app
$ make ARGS="-Denv=/path/to/.env" run
```

Whenever you do changes, please make sure to run the following commands locally:

```bash
# to make sure unit and quality testing passed.
$ make ci

# to format the new code changes.
$ make format

# To list all commands
$ make
```

### Deployment:

You can build and run the jar like this:

```bash
$ make build

$ java -jar build/libs/reindeer-1.1.3-fat.jar --env=/path/to/.env
```

### Deployment with Docker:

To run from docker image:

```bash
$ docker run -d \
--env APP_PORT=8000 \
--env DB_CONNECTION=h2 \
--env DB_HOST=127.0.0.1 \
--env DB_PORT=3306 \
--env DB_DATABASE=/app/storage/db \
--env DB_USERNAME=root \
--env DB_PASSWORD=secret \
--name=reindeer \
--publish 8000:8000 \
clivern/reindeer:1.1.3
```

Or with docker compose

```bash
$ docker-compose up -d
```

## Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Reindeer is maintained under the [Semantic Versioning guidelines](https://semver.org/) and release process is predictable and business-friendly.

See the [Releases section of our GitHub project](https://github.com/silverbackhq/reindeer/releases) for changelogs for each release version of Reindeer. It contains summaries of the most noteworthy changes made in each release.

## Bug tracker

If you have any suggestions, bug reports, or annoyances please report them to our issue tracker at https://github.com/silverbackhq/reindeer/issues

## Security Issues

If you discover a security vulnerability within Reindeer, please send an email to [[email protected]](mailto:[email protected])

## Contributing

We are an open source, community-driven project so please feel free to join us. see the [contributing guidelines](CONTRIBUTING.md) for more details.

## License

**Reindeer** is authored and maintained by [@Silverbackhq](http://github.com/silverbackhq).