Skip to content

Latest commit

 

History

History
127 lines (85 loc) · 5.07 KB

README.md

File metadata and controls

127 lines (85 loc) · 5.07 KB
Raw

PAC Belgrade 2020 - Conference Application POC

Logo

client api FOSSA

Product Vision

The Conferencing App is a fictive but easy to understand business application. The customers organises events and wants to get rid of printed paper and digitise the business. The intention is to have a central place where all details about events, talks, persons a.s.o. are stored. The system must support multiple frontends (e.g. Web or Mobile phone). The system must be scalable because while the events take place the load gets very high. So the architecture must compensate for that. Additionally monitoring must ensure that bottlenecks can be detected early to prevent low performance.

Points of Contact

Role Name Email Teams
Product Owner Darko Krizic [email protected] @Darko Krizic
Maintainer Milos Nikolic [email protected] @Milos Nikolic

Stack

Running project in local Minikube

  • Go to client folder and run npm install in order to install all frontend dependency.

  • Go to api folder and run npm install in order to install all backend dependency.

  • Follow the steps described here in order to prepare minikube and hosts.

  • Go into infrastructure/terraform folder and run ./install. This will run terraform and install all the components to Minikube.

  • Front end of the application can be accessed at http://conference.frontend

  • Backend end of the application can be accessed at http://conference.backend

  • Datadog monitoring of the application can be accessed at https://app.datadoghq.eu

Local Development Only

For local development, a docker-compose file is provided to spin up both the API, DB and UI inside of containers, with their filesystems volume-bound to the local repos. Changes to the repos should be automatically detected, and the containers updated within a few seconds.

I use workspaces in order to leverage one config for eslint/prettier. The downside here is you need to be careful to use "Open Workspace" to load this file instead of opening the pac/ folder itself.

Setup

Prior to starting the containers, you'll need to create the environmental configs for both containers. The configs are stored in /devenv. Examples are provided. Copy the example files, removing the .example from the name ( ie: .env.example -> .env). After creating the env files, populate them with the needed values.

Starting

Please note the below mentioned commands need to run from the project root in order to start dev env using docker. A similar thing can be achieved going to every service and run npm run dev.

Once the environmental configs are setup, you can bring up the environment by running

docker-compose up

You can stop the containers by using Ctrl+C on the terminal, or using

docker-compose down

Reset Database

It sometimes helps to completely reset your database. Also when doing the setup, the very first time, schema needs to be created.
In such cases run: docker-compose run api npm run migrate -- --rebuild

Migrate Database

When database schema changes, or new data migrations are created, you can migrate your existing database by running: docker-compose run api npm run migrate

Seeding Test Data

Seed test data with: docker-compose run api npm run seed

/
|
├─ .github/                     # Github Actions to build and check the project
├─ api/                         # Backend application
├─ client/                      # Frontend application
├─ dotenv/                      # Environment variables
├─ infrastructure/              # Infrastructuree of the application
|
├─ docker-compose.yaml          # Config to run app in local docker container
├─ .gitignore                   # List of files and folders not tracked by Git
└─ README.md                    # This file

Services