GoRestaurant

Italian food, yes!
Show and modify a restaurant menu.
Created with ReactJS and React Native, all with Typescript.
_{Made with ❤️}

⚠️ Note

This project was made in 2020 with portfolio and study purposes and is no longer in maintenance. The code is under the MIT license, so feel free to clone it and use it the way you want but keep in mind that you probably will need to update some dependencies.

📌 Contents

• Features
• Installation
• Getting started
• Techs
• Issues
• License

🚀 Features

Web

• List all the plates of your restaurant
• Create new plates
• Update plates that already exists
• Delete plates
• Turn plates to available or unavailable

Mobile

• Search plates by category and name
• Create an order with extras and set the quantity
• See your orders
• Favorite plates
• See your favorite plates to order them again!

🔧 Installation

Required ⚠️

• Node.js
• Yarn

SSH

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have an SSH key registered in your GitHub account, clone the project using this command:

git clone [email protected]:LuizFerK/GoRestaurant.git

HTTPS

In case you don't have an SSH key on your GitHub account, you can clone the project using the HTTPS URL, run this command:

git clone https://github.com/LuizFerK/GoRestaurant.git

Both of these commands will generate a folder called GoRestaurant, with all the project

💡 Getting started

Web

1. Open the web folder and run yarn to install the dependencies
2. This app uses a fake api. In the project folder, run yarn json-server server.json -p 3333 -H YOUR-IPV4-ADDRESS
3. Run yarn start to open the web application on port 3000. (the app will open in your browser automatically)

Mobile

1. Open the folder and run yarn to install the dependencies;
2. This app uses a fake api. In the project folder, run yarn json-server server.json -p 3333 -H YOUR-IPV4-ADDRESS;
3. In src/services/api.ts change the baseURL for your IPv4 address: baseURL: 'http://YOUR-IPV4-ADDRESS:3333'
4. Connect your device to your computer and enable the debugger mode on the developer tools

Make sure that the device is connected to the USB port and it is listed on the system (run adb devices on a terminal)

5. Run yarn start to open the metro-bundler and get access to the server app on mobile
6. Run yarn android to install the app on your Android or yarn ios to run on your IOS

🔥 Techs

Typescript (language)

JSON Server (fake API)

ReactJS (web)

• Axios
• React Modal
• React Router DOM
• Styled Components

React Native (mobile)

• @React Navigation | Stack
• Axios
• Styled Components

🐛 Issues

Find a bug or error on the project? Please, feel free to send me the issue on the GoRestaurant issues area, with a title and a description of your found!

If you know the origin of the error and know how to resolve it, please, send me a pull request, I will love to review it!

📖 License

Released in 2020.

This project is under the MIT license.

< keep coding /> 🚀 ❤️