README.md

Developed Features • Techs • Running WaiterApp • Contributing for WaiterApp

Developed Features

API

• Categories CRUD
• Products CRUD
• Orders CRUD
• Image Upload
• WebSocket communication

Frontend

• Dashboard for monitoring and changing the status of orders placed on the APP;

Mobile

• App that will be used by the waiter to take customer orders;
  • List products;
  • Create Orders;
  • Filter products by category;

---

💻 Prerequisites

Before you begin, make sure you've met the following requirements:

• NodeJs;
• Docker
• React Native environment setup;
• Android/IOS emulator.

📦 Preparing environment

To run the application, follow these steps:

Download the project and install the dependencies:

# Clone this repo
git clone https://github.com/Chriszao/waiter-app.git

# Enter the project folder
cd waiter-app

# Install deps 
# P.S: You can use the package manager of your choice. 
# but this project were developed with yarn, and works better with it
yarn # inside of each project folder

# Inside each project have a “start” script that does start the service server
yarn start # <inside of project>
# P.S: just in frontend we have to run yarn dev to start the server.

---

🛠️ Technologies

• Typescript;
• NodeJs;
• Express;
• React Native;
• Styled Components;
• MongoDB;
• Vite;
• Socket.io;

Developed with 💙 by Chriszao