Table of contents

About • Features • Layout • How to run • Technologies • Author • License

💻 About the project

GoRestaurant is a web application to support restaurants to control their menu.

To see the mobile client, click here: GoRestaurant mobile

---

⚙️ Features

The web page was designed to be used by restaurant's owners to control their menu.

• List registered dishes

• Edit an existent dish information

• Add a new dish to the menu

• Delete a dish

• Switch dish availability

---

🎨 Layout

---

🚀 How to run the project

Requirements

Initial requirements: git, yarn, and a code editor of your choice.

Running the web application (Frontend)

# Clone this repository
$ git clone git@github.com:wilsonfsouza/GoRestaurant-web.git

# Access the folder in your terminal/cmd/cli
$ cd GoRestaurant-web

# Install all dependencies
$ yarn install

# Start json server
$ yarn json-server server.json -p 3333

# Start the app in development mode
$ yarn start

# The application will open at port:3000 - access http://localhost:3000

---

🛠 Technologies

The following tools were used in this project:

Website (React + TypeScript)

• React Router Dom
• React Icons
• Styled-components
• Axios
• Yup
• Jest
• ESLint
• Prettier
• EditorConfig

See the file package.json

Utilities

• Editor: Visual Studio Code
• Markdown: Markdown Emoji
• Icons: Feather Icons

---

💪 How to contribute to this project

1. Fork the project.
2. Start a new branch with your changes: git checkout -b my-new-feature
3. Save it and create a commit message describing what you have done: git commit -m "feature: My new feature"
4. Send your alterations: git push origin my-feature

---

👨‍💻 Author

_{Wilson Franca}

---

📝 License

This project is being developed under MIT License.

Made with ❤️ by Wilson Franca 👋