OfficeBuddy is a simple office management application. It's my pet project to expand my knowledge about some new areas and reinforce the knowledge of the ones I already know.

Things you'll find in this project:

• small-scale DDD approach
• purely functional backend written in Scala with Cats Effect
• tests written using Weaver and Mockito Scala
• mobile-first frontend written in Angular using mostly GitHub Copilot (it turns out it's quite good!)
• ...and probably more to come in the future if I continue the development 😄

Improvements yet to be made are marked with TODOs in the code and listed in the issues.

ℹ️ You might want to open the diagram in a separate tab or upload it to Excalidraw to see the details.

The below setup assumes the default config set up in the repository files.

To run the infrastructure, use the following command:

docker-compose -f docker/infra.yaml up -d --wait

This will run Postgres database, Keycloak and Mailpit containers. To run the backend, use:

sbt run

And to run the frontend:

cd ui
ng serve

The frontend app will be available at http://localhost:4200.

When the app is first run, it creates a superadmin account with the following credentials:

• username: [email protected]
• password: superadmin

It then can be used to configure the app. The app loads some demo data by default, including accounts. Other accounts are available when you use "Forgot password" in the login form. Provide the email address of the account you want to use, and the password reset link will be available in Mailpit at http://localhost:8025.

The API documentation can be found at http://localhost:8080/docs endpoint by default.

To obtain bearer token for existing account to use the API, use the following curl command:

OB_KEYCLOAK_URL='http://localhost:8888'
OB_USERNAME='<username>'
OB_PASSWORD='<password>'
curl -s -L -X POST "$OB_KEYCLOAK_URL/realms/office-buddy/protocol/openid-connect/token" \
-H "Content-Type: application/x-www-form-urlencoded" \
--data-urlencode "client_id=office-buddy-ui" \
--data-urlencode "grant_type=password" \
--data-urlencode "username=$OB_USERNAME" \
--data-urlencode "password=$OB_PASSWORD" | jq -r '.access_token'

To close the app, first cancel the frontend and backend processes. Then, use the following command to remove the infrastructure:

docker-compose -f docker/infra.yaml down

To run the app in containers only, use the following:

# Build the backend image
sbt Docker/publishLocal

# Build the frontend image
docker build -t officebuddy-ui:latest \
  --build-arg KEYCLOAK_URL=http://localhost:8888 \
  --build-arg KEYCLOAK_REALM=office-buddy \
  --build-arg KEYCLOAK_CLIENT_ID=office-buddy-ui \
  --build-arg BACKEND_PROXY_URL=http://backend:8080 ./ui

# Run the app  
docker-compose -f docker/office-buddy/docker-compose.yaml --env-file docker/.env up -d

The addresses of the app are the same as described in Running on local machine section.

To close the app, use the following command:

docker-compose -f docker/office-buddy/docker-compose.yaml down