README.md

About Amorr

Amorr is a web application that serves as an online platform providing users with the luxury of choosing receiving various services such as haircuts, manicures, massages, makeup, and more in the comfort of their home.

Problems that Amorr solves

Amorr provides a convenient way to find and have beauty services provided to people who:

1. Do not have the time (Scheduling issues or Traffic) and/or
2. Do not have the means of transportation and/or
3. Do not know about the quality of service

Tools used in Development

• Frontend: React (Installation guide here)
• Backend Database: MySQL (Installation guide here)
• Connector: Flask (Installaton guide here for Flask and here for Python)

Guideline to use Amorr

Clone down this repository by running

git clone https://github.com/UTSCCSCC01/finalprojects22-stackato-studio.git

Install Backend Dependencies

pip install pymysql
pip install pandas

Install Flask with pip

pip install Flask

python app.py

Then, you will need node and npm installed globally on your machine.

To install npm, run the following commands

node -v

npm -v

MySQL Installation is done using the npm install command

npm install mysql

Sometimes it may also ask you to install the latest version from Github to check if a bugfix is working. In this case, please do

npm install mysqljs/mysql

This project uses yarn to handle dependencies, to install yarn run

npm install -g yarn

To install all the necessary JavaScript packages for the frontend

yarn install

To start the Server

npm start

To Visit App

localhost:3000/amorr

Development Team

Amorr is currently being developed by a Stackato Studio:

1. Efkan Serhat Goktepe
2. Jumana Fanous
3. Annanya Sharma
4. Shannon Budiman
5. Mir Safwat Ayser
6. Theora Gavrila Pui
7. Christopher Nathanael

Development Process

Development follows the Scrum Agile Development Methodology with Efkan Serhat Goktepe as our Scrum Master

Workflow

We follow the git flow with 2 types of branches: the development branch and the feature branch

Branch naming convention

• Development Branches correspond to sprints thus would be named "development-sprint#" (example: "development-sprint2")
• Feature Branches would be named "STAC-##-feature-clear and concise feature description" (example: "STAC-22-feature-signup-page")

Measuring Project and Tasks

• Jira Boards are used to keep track of tasks and overall progress

Open Source Contributing

• If you have a suggestion that would make this better, please fork the repo and create a pull request.
• Open a new issue with the label "Open Source Enhancement: " in the beginning.

Steps:

1. Fork the Project
2. Create your Feature Branch
3. Commit your Changes
4. Push to the Branch
5. Open a Pull Request