Skip to content

Project built during Rocketseat's Next Level Week #3

License

Notifications You must be signed in to change notification settings

DiegoVictor/happy-web

Repository files navigation

[Web] Happy

GitHub Workflow Status typescript react styled-components eslint airbnb-style jest coverage MIT License PRs Welcome

This web version allow users to look for orphanages near from yourself, see details about it and create new ones.

Table of Contents

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

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.