Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Pedroo123 committed Jun 22, 2020
1 parent 9ffcf2b commit f660785
Showing 1 changed file with 9 additions and 24 deletions.
33 changes: 9 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,7 @@ Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.<br />
You will also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.<br />
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm mock`
### `npm run mock`

Launches the mock on the port **4000**

Expand All @@ -30,34 +25,24 @@ Launches the mock on the port **4000**
### Components

- Structured with functional and class components.
- The functional components have some writtens tests.

### CSS

- CSS3 only
- Decided not to use a framework because i wanted to make it simple, and quick.

### Google Maps API // Google Maps React

### Static Data

- The decision behind this was again, work quickly and simple as possible. Mocking an API that could POST, GET, PUT and also DELETE an information would take more time.
- I could search for some public APIs to fetch info, but the idea came to my mind just before I finish the project


-----------------

## Things I wanted to do.

- I wanted to make it as simple and quickly as possible. I dont know how much time I have avaliable, so that is the reason I made that decision.
- I decided to use this API, because it has a public package that is pretty simple to use.

- I wanted to make it bigger, with more details and some graphics to make it prettier. But as I said before, it would take a bit more effort and thus, more time.
- The only thing that i didnt like about it, was the billing needing to be avaliable to make the request.

- Some things I left with a comment. Those are things that I would do if I'd encounter myself on the situation mentioned on the comment. I hope you can read those carefully.
### Recharts

- The most simple lib for charts that i could find on the internet. Since making a chart from ground zero takes time, i decided to use it because it has some pre-built charts, that you could simply import on your class, and pass your data on it.

--------------------
## Final note.

## Final note
- Removi os testes porque vi que nao fariam muito sentido, afinal de contas nao estavam testando muita coisa.

- I hope you like it. It took me around a week to do it. Working on it about an hour per day. Thats the free time that I had during those days, and I used it totally on the project.
- I loved the experience and learned a lot during the process. Thanks for the opportunity.
- Agradeço a oportunidade, mesmo se nada der certo, fico feliz por tentar.

0 comments on commit f660785

Please sign in to comment.