Agenda Hair App

About

This project implements a simple app for scheduling, using React.js in the Front-end and Flask in the Back-end

We developed this app as requested for the Web Development discipline of the BSI graduation course. This course is offered by IFNMG Campus Januária.

Project Specification

• Create a scheduling App with a static and form pages using resources of the React.js Framework.
• Provide APIs to get, edit and make schedules.
• (optional) Provide a API to Login
• Use a database to saves the infos.

Obs: This is a simple app, some features, errors and security threatments may be not available.

Technologies

The app is containerized with Docker, and the features are developed using React and Flask to provide the APIs

• Docker
• Docker-compose

Front-end

• React.js

Back-end

• Python
• Flask Framework

Database

• Postgresql

How to Set-up the project

Requirements:

• Docker and Docker-compose must be installed in your local machine
• Is prefered to run this app in Linux envrioment (also can be Windows WSL)

How to run

• Clone this repository: git clone https://github.com/bernardoadribeiro/agendahair-app.git
• Go to project folder: cd agendahair-app
• Create the .env file: cp .env.sample .env (do it for the .env.sample in root and backend folders)
• (open Docker Desktop before continue if you are using WSL)
• Run: docker-compose up and wait.
• You will see a success message in the terminal

Migrations

• Run the following lines when needs to manage migrations:
• Usage: flask db [OPTIONS] COMMAND [ARGS]...

• flask db init: to create a folder with set to migration.
• flask db migrate -m "Initial migration.": to generate a migration.
• flask db [upgrade|downgrade]: to up/down changes based on migration files.
• flask db --help: Show database help message.

How to access the app

• Front-end URL: http://localhost:3000
• Back-end URL: http://127.0.0.1:5000/api/v1
• APIs docs (Swagger): http://127.0.0.1:5000/apidocs/#/

Useful commands

• docker-compose up: Run all containers
• docker-compose down: Stop all containers
• docker-compose build [backend | frontend | database]: Re-build a specific container
• Install React dependencies: cd frontend && npm install