Table of contents

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

💻 About the project

GoRestaurant is a mobile application for online ordering meals at your favorite restaurant.

To see the web client, click here: GoRestaurant Web

---

⚙️ Features

The app was designed to be used by clients to order meals at their favorite restaurant.

• Home screen

• Menu tabs: dishes, orders, and favorites

• Screen listing available dishes with search field and category filters

• Screen showing orders made by the client

• Screen showing user's favorite dishes

• Screen showing meal's details and order overview. The user can modify the order by adding extras or increasing the number of dishes. The total amount for the order is shown before placing order.

---

🎨 Layout

---

🚀 How to run the project

Requirements

Initial requirements: git, yarn, an emulator to run the app, and a code editor of your choice.

Running the mobile application

# Clone this repository
$ git clone https://github.com/wilsonfsouza/gorestaurant-react-native.git

# Access the folder in your terminal/cmd/cli
$ cd gorestaurant-react-native

# Install all dependencies
$ yarn install

# Make sure the file 'src/services/api.ts' have the IP to your API
# Start json server
$ yarn json-server server.json -p 3333

# Start the app
## Android
$ yarn react-native run-android

## iOS - install dependencies
$ cd ios
$ pod install
$ cd ..
$ yarn ios

---

🛠 Technologies

The following tools were used in this project:

Mobile (React Native + TypeScript)

• React Native
• React Native Vector Icons
• React Navigation
• Styled-components
• Jest
• Axios
• 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 👋