marcelohcortez / beerapp

Brewery searcher with localStorage favorites functionality

Beer Wiki

Brewery searcher with localStorage favorites functionality. Implements PWA approach with Workbox so the project can function when 'offline'.

It uses the Open Brewery DB as the API.

The app is fully functional and responsive.

The project doesn't run with Nodejs and Express (purposely), so in order to test the PWA part you can just use the 'serve' as indicated on the instructions.

Tech & 3rd party used in the project:

• React
• TypeScript
• Axios
• React Router
• Workbox
• Material UI
• Webpack

How to run the project:

• Clone the repository
• Install the modules, run

  npm install

• Since we are not using Nodejs and Express, in the main folder, run

  REACT_APP_API=https://api.openbrewerydb.org/v1/ npm run build

• And then start the server with the 'dist' folder as the root

  serve -s dist

• To test the 'offline' functionality, on your DevTools, in the tab 'Network', instead of the option 'No Throttling', select 'Offline'.

The cache stores anything that has been previously fetched in the API, so before going 'offline' visit some areas that fetch content from the API