DiegoVictor / proffy-web

Project built during Rocketseat's Next Level Week #2

[Web] Proffy

This web version allow users to register yourself, reset your password, log in, update your information, check others classes availability and share your own classes availability. All the resources used by this application comes from its API.

Table of Contents

• Screenshots
• Installing
• Configuring
  • .env
  • API
• Usage

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 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 with version (v1)	http://localhost:3333/v1

API

Start the API (see its README for more information). In case of any change in the API's port or host remember to update the .env too.

Usage

To start the app run:

$ yarn start

Or:

npm run start