A progressive web app with 100/100 PWA score from Google Lighthouse.
Uses:
- React and Fetch API to retrieve and explore the data from swapi
- Service Worker API and sw-precache to store the assets for offline usage
- IndexedDB to store from the API's data and refresh with a given throttling interval
- Jest and enzyme for unit testing
Stands for The (S)tar (W)ars (A)PI's (D)ata (E)xplore(R).
The latest version of the app is available here:
- https://swader.now.sh (http/2)
- https://swader.surge.sh (http/1.1)
Use the latest version of Google Chrome or Mozilla Firefox since they support all necessary PWA features, such as Service Worker. Safari 10 works fine with IndexedDB, but doesn't support Service Worker yet.
More info about Service Worker and other PWA features support and can be found here.
# install the dependencies
npm install
# to start local dev server on http://localhost:3000
npm run start:dev
# make and preview production build on http://localhost:5000
npm run build && npm run start
Or if you prefer yarn:
# install the dependencies
yarn
# to start local dev server on http://localhost:3000
yarn start:dev
# make and preview production build on http://localhost:5000
yarn build && yarn start
# with npm
npm test
# with yarn
yarn test
The app is preconfigured for now.sh or surge.sh deployment.
Simply run now-cli from the app's folder. There is no need to create a production build before deployment.
now
It will be deployed as a node app, built in the cloud and served with serve.
Use preconfigured npm script deploy:surge, optionally specify a domain:
# with npm
npm run deploy:surge -- <domain>
# with yarn
yarn deploy:surge -- <domain>
It will create a production build, copy index.html to 200.html to let Surge handle react-router routes and upload build folder contents to Surge CDN.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
This project is licensed under the MIT License - see the LICENSE file for details