Dona Birita 🍺

Project Context 💡

Beverage delivery platform for the fictitious distributor Dona Birita.

Contributors 👥

• Carolina Lima
• Elivelton Machado
• Rafael Silva
• Victor Mendes
• Wlisses Fernando

Main functionalities by user 🔧

Customer:

• Perform login;
• Perform registration;
• Choose to add items to the cart;
• Place order;
• Monitor the status of orders placed;
• Change order status to "Delivered";

Salesperson:

• Perform login;
• track orders;
• Change the status of orders to "Prepare Orders" and "Out for Delivery";

Admin:

• Perform login;
• View users;
• Register new users;
• Delete users;

Acquired Knowledge 📖

In this project, We were able to:

• Develop a Full Stack application;
• Integrate front-end and back-end;
• Build a REST API;
• Organize the code and the general architecture of the application;
• Work together, using daily meetings and Kanban;

Main Technologies 🧰

Back-End

JavaScript	Express	Sequelize	Node.JS	MySQL	JWT	Docker

Front-End

JavaScript	HTML5	CSS3	React	SASS

Testing

Jest	RTL	Mocha	Chai	Sinon

Running the application ⚙️

Client default port: 3000
API default port: 3001
Database default port: 3002

1. Clone the repository and enter it

git clone git@github.com:ImVictorM/Dona-Birita.git && cd Dona-Birita

🐋 Running with docker (recommended)

2. Get the containers running

docker-compose up -d

3. Enter the api container to create the database

docker exec -it api-delivery sh

4. Create and populate the database

npm run db:reset

5. Access the page on your browser: http://localhost:3000/

🖥️ Running locally

You must have node and MySQL installed

2. Install the dependencies (both back-end and front-end)

npm install

3. Rename the file .env.example to .env in both front-end and back-end directory (change it as you like)

4. Create and populate the database

npm run db:reset

5. Start the server

npm run start

6. Access the page on your browser: http://localhost:3000/

Testing 🛠️

Running all test files:

npm test

Running back-end test files:

npm run test:backend

Running front-end test files:

npm run test:frontend

Application test coverage:

npm run test:coverage

Back-end test coverage:

npm run test:backend:coverage

Front-end test coverage:

npm run test:frontend:coverage