README.md

My City - My Places

Table of Contents

• Getting Started
  • Prerequisites
  • Run
  • Stop
• Built With
• Architecture
• Authors
• Documentation

Getting Started

Prerequisites

Create your secret files:

mkdir secrets
echo my_super_db             > secrets/database_db
echo my_super_user           > secrets/database_user
echo my_super_password       > secrets/database_password
echo my_super_email          > secrets/email_address
echo my_super_email_password > secrets/email_password
echo my_super_auth_jwt_key   > auth_jwt_key

You can also run secrets.sh script to generate those files:

./secrets.sh

In order to run this project, you must have installed docker-compose.

Run

To run the project on a local environment, use:

# run
docker-compose up

# run in detached mode (background)
docker-compose up -d

# rebuild images
docker-compose up --build

Stop

To run the the docker stack, use:

# stop
docker-compose down

# stop and remove created volumes
docker-compose down -v

Authors

Irina Dinu-Murguleț

Oana-Luciana Neagu

Gabriel David Roșu

Andrei-Liviu Samoilă

Documentation