README.md

[Web] GoRestaurant

This web application allow users to register, update and set foods as available to be ordered in your restaurant. All the resources used by this application comes from a fake API.

Table of Contents

• Screenshots
• Installing
  • Configuring
    • .env
    • API
• Usage
• Running the tests
  • Coverage Report

Screenshots

Click to expand.

Installing

Easy peasy lemon squeezy:

$ yarn

Or:

$ npm install

Was installed and configured the eslint and prettier to keep the code clean and patterned.

Configuring

Configure your environment variables and remember to start the Json Server API before to start this app.

.env

In this file you may configure the API's url. Rename the .env.example in the root directory to .env then just update with your settings.

key	description	default
REACT_APP_API_URL	API's url	http://localhost:3333

API

This application make usage of a third party library to create a fake API, you can see more information about it in JSON Server repository.

To start the API run:

$ yarn json-server server.json -p 3333

Or:

$ npx json-server server.json -p 3333

Remember to update the .env if you choose another port or host

Usage

To start the app run:

$ yarn start

Or:

npm run start

Running the tests

Jest was the choice to test the app, to run:

$ yarn test

Or:

$ npm run test

Coverage report

You can see the coverage report inside tests/coverage. They are automatically created after the tests run.