Full-stack development

Clone the following repo:

git clone git@github.com:openartcoded/monorepo.git

You need a valid SSH public key linked to your github account

If it's the first time that you clone the repo, you then need to run within the cloned folder:

git submodule update --init --recursive --remote

Next time you want to update all repo, run the following command:

git submodule update --recursive --remote

Go to:

cd app-docker/

Copy the .env file:

cp .env.monorepo.example .env

For windows users, you will need to change the content of the file with:

COMPOSE_FILE=docker-compose.yml;docker-compose.monorepo.yml

Build the stack:

docker compose build

Once done, up the stack:

docker compose up -d

In the terminal, run:

docker exec -it app-docker-keycloak-1 /opt/keycloak/bin/kc.sh import \
        --file /tmp/import/artcoded-realm.json

For Windows users

docker exec -it app-docker-keycloak-1 /opt/keycloak/bin/kc.sh import --file /tmp/import/artcoded-realm.json

Add the following into your /etc/hosts

    127.0.1.1       auth.somehost.org
    127.0.1.1       somehost.org
    127.0.1.1       backoffice.somehost.org
    127.0.1.1       mail.somehost.org

Open a private browsing window and visit BackOffice

Default credentials:

    username: nordine
    password: 1234

If you get multiple warnings from your browser when opening the link, this is normal. Certificates are self-signed (only local)

Expenses & Reminder Tasks features

Expenses management & reminder tasks use email to receive expenses from a known email address (in the case of expenses), and send email in case of a reminder task. To test both features, follow these instructions:

  • On the top-right of https://backoffice.somehost.org, click on "Personal Info" then "Contact/Bank" and change the email address to noreply@somehost.com

  • Open a new tab & Go to https://mail.somehost.org . You can login with username: noreply@somehost.com , password: noreply

  • Send an email with an attachment (pdf or image) to fee@somehost.com => after a few seconds you should see a notification coming in on https://backoffice.somehost.org

  • Create a new reminder task. Choose "Send Mail". Once the task is triggered, go back to https://mail.somehost.org and login, you should see an email with the reminder.