Contributing to PWA Boilerplate

This project is intended to be a safe & welcoming space for collaboration. Contributors are expected to adhere to the code of conduct.

Development

Fork & clone the repo running the following command:

git clone git@github.com:<Your-Username>/pwa-boilerplate.git

or clone using HTTP

git clone https://github.com:<Your-Username>/pwa-boilerplate

Install the modules by running

yarn install

Now you can create a new branch from master:

git checkout -b my-feature origin/master

You can use the following development command:

yarn development

This will automatically start your project in development mode with hot reload.

It's possible that the service worker offline mode won't work correctly in development mode due to the hot reload plugin.

If you wish to test this functionality, you should run it in production mode:

yarn build && yarn start

Have a look at docs, they go into more details on functionality and project's set-up.

When creating a new Pull Request, please ensure that you follow the PR template.