Local Setup

Lets make that easy. Best would be if you use MacOS but we don't blame if not.

Docker

First of all you need docker.

macOS

https://docs.docker.com/desktop/setup/install/mac-install/

Windows

https://docs.docker.com/desktop/setup/install/windows-install/

Linux

https://docs.docker.com/desktop/setup/install/linux/ubuntu/

IDEA

Get the IDEA of your choice, but please leave if you use Eclipse. Else here what you need to do in your IDEA's. IntelliJ Community can be used but is not recommended and also doesn't work with Dev Containers so shit is up to you then. Ultimate plugins make your live easier or use VSCode (No support here)

IntelliJ IDEA Ultimate

1. Install IntelliJ
2. Add plugin https://plugins.jetbrains.com/plugin/21962-dev-containers
3. Go to Remote Development - Dev Containers -> New Dev Container
4. Enter GitHub project ssh url (we dont use https please)
5. Wait until run

VSCode

1. Install VSCode
2. Add plugin https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers
3. Clone GitHub project
4. Open GitHub project
5. VSCode will ask to run it as Dev Container because it finds the devcontainer.json file

The Whale

Almost done. Now we need some containers to run a smooth application.

Clone this repository with ssh:

https://github.com/Arematics/dev-toolbox

Go into project root and run:

docker compose -p "Arematics Toolbox" up -d

This setup runs a PostgreSQL database available on the default postgres port, a redis cache under 22222, a keycloak authentication provider under port 8888 with all configurations you need for our applications and a Hashicorp Vault client under 8333.

Authentication

Login to keycloak admin

http://host.docker.internal:8888/auth/admin/master/console/#/arematics/clients

Username: localadmin
Password: local

Normal App Login

Username: User
Password: admin

Notice

Some apps might have extensions in their README files.