emunhoz/get_address

Demo: https://findaddress.netlify.com

Find Address with Google Maps and ViaCep

About this app

• At the begining I setup Prettier, ESLint and EditorConfig code patterns
• For the components I decided to use styled-components to style, because it keep the code very clean and it's very friendly
• For testing I've used testing library to integration tests and cypress to e2e
• For requests I decided to use axios cause is very simple to use

🚀 Quick Start

1. Clone this repo and you'll need to create a .env at root with REACT_APP_GOOGLE_API_KEY=YOUR_GOOGLE_API_KEY_HERE variable with your Google maps api key

2. Install all dependencies.

   yarn
   

3. Start the site in develop mode.

   yarn start
   `localhost:3000`

What's included?

• React
• React Hooks Only
• Styled components 💅💅💅
• react-hook-form to validate forms
• PWA 100% - Audits o/
• Axios
• Storybook with components
• Google Maps API
• Viacep API

🚨 Code standard

• JavaScript Standard Style - Javascript styleguide
• Prettier - Code formatter
• ESLint - Lint to quickly find problems

🚥 Testing

• Jest - A delightful JavaScript Testing Framework with a focus on simplicity
• Testing Library - Simple and complete testing utilities that encourage good testing practices
• Cypress - Fast, easy and reliable testing for anything that runs in a browser

Available commands

npm i or yarn to install all dependencies

yarn storybook to see all components

yarn start to run app at localhost:3000

yarn test --coverage to see all the tests

yarn start with yarn run cypress open at the same time to run e2e tests