https://github.com/diegovictor/rocketshoes-web
Project built during the Rocketseat Bootcamp #08
https://github.com/diegovictor/rocketshoes-web
coverage-report editorconfig eslint gostack javascript jest js json-server node nodejs prettier react reactjs rocketseat rocketshoes
Last synced: about 2 months ago
JSON representation
Project built during the Rocketseat Bootcamp #08
- Host: GitHub
- URL: https://github.com/diegovictor/rocketshoes-web
- Owner: DiegoVictor
- License: mit
- Created: 2020-08-24T21:59:43.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-28T13:00:22.000Z (4 months ago)
- Last Synced: 2025-03-05T08:42:45.418Z (2 months ago)
- Topics: coverage-report, editorconfig, eslint, gostack, javascript, jest, js, json-server, node, nodejs, prettier, react, reactjs, rocketseat, rocketshoes
- Language: JavaScript
- Homepage:
- Size: 2.08 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Web] Rocketshoes
[](https://github.com/DiegoVictor/rocketshoes-web/actions)
[](https://reactjs.org/)
[](https://styled-components.com/)
[](https://eslint.org/)
[](https://github.com/airbnb/javascript)
[](https://jestjs.io/)
[](https://codecov.io/gh/DiegoVictor/rocketshoes-web)
[](https://raw.githubusercontent.com/DiegoVictor/rocketshoes-web/main/LICENSE)
[](http://makeapullrequest.com)
This web application simulate a simple shoes store with cart system. All the resources used by this application comes from a fake [API](#api).
## Table of Contents
* [Screenshots](#screenshots)
* [Installing](#installing)
* [Configuring](#configuring)
* [.env](#env)
* [API](#api)
* [Usage](#usage)
* [Running the tests](#running-the-tests)
* [Coverage Report](#coverage-report)
# Screenshots
Click to expand.
# Installing
Easy peasy lemon squeezy:
```
$ yarn
```
Or:
```
$ npm install
```
> Was installed and configured the [`eslint`](https://eslint.org/) and [`prettier`](https://prettier.io/) to keep the code clean and patterned.
## Configuring
Configure your environment variables and remember to start the [Json Server](https://github.com/typicode/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](https://github.com/typicode/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](https://jestjs.io) 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.