README

This README would normally document whatever steps are necessary to get the application up and running.

Setting up developement environment

• To run this project, you have to follow the below steps:

• First, clone the project using git clone https://github.com/MohanedMashaly/app-factor.

• Navigate to the project using cd app-factory.

• Install docker, to check if you have installed or not type in your cmd docker --version.

• type docker build . in your terminal to build the docker file.

• make sure docker-compose is installed.

• Run docker-compose build .

• Run docker-compose run app bin/rails db:migrate RAILS_ENV=development

• To run the whole stack, write docker-compose up in your terminal.

API docs

• https://docs.google.com/document/d/1CwhWV5jsAKrIAjnGcutCI9ETv2gCOyYhXc8U5TlD5Y0/edit#

Database ERD

https://drive.google.com/file/d/1cKXifc4tsgRByYklPZ1rdjXJ_GxvbJ_u/view?usp=sharing

system requirements

• Ruby version

• System dependencies

• Configuration

• Database creation

• Database initialization

• How to run the test suite

• Services (job queues, cache servers, search engines, etc.)

• Deployment instructions

• ...