raphaelswk / go-restaurant Goto Github PK

View Code? Open in Web Editor NEW

Go Restaurant - is an easy and quick way to manage a resaurant dishes, with a simple and nice layout you are able to access all its features. Project was a challenge developed during GoStack Bootcamp offered by Rocketseat in order to practise CRUD concepts using ReactJS and TypeScript. GoStack Bootcamp is an online experience with lots of practical content, challenges and hacks.

JavaScript 2.20% HTML 1.77% TypeScript 96.03%

go-restaurant's Introduction

Go Restaurant

Status: Finished

About • Features • Layout • How it works • Tech Stack

About

Features

List API's food dishes
Add new food dishes to the API
Edit food dishes from API
Remove food dishes from API
Change availability of API's food dishes

Layout

The application layout is available on Figma:

Web

How it works

This project is divided into two parts:

Backend (server file)
Frontend

Frontend needs the Backend to be running to work.

Pre-requisites

Before you begin, you will need to have the following tools installed on your machine: [Git] (https://git-scm.com), [Node.js] (https://nodejs.org/en/) and [Yarn] (https://classic.yarnpkg.com/en/). In addition, it is good to have an editor to work with the code like [VSCode] (https://code.visualstudio.com/)

Running the web application (Frontend)

# Clone this repository
$ git clone https://github.com/raphaelswk/go-restaurant.git

# Access the project folder in your terminal
$ cd go-restaurant

# Install the dependencies
$ yarn

# Run the backend
$ yarn json-server server.json -p 3333

# Run the application in development mode
$ yarn start

# The application will open on the port: 3000 - go to http://localhost:3000