Skip to content

Latest commit

 

History

History
41 lines (35 loc) · 935 Bytes

File metadata and controls

41 lines (35 loc) · 935 Bytes

Adding documentation

  • The development branch is master.
  • All pull requests should be opened against master.

To develop locally:

  1. Clone the next-pwa repository:

    git clone https://github.com/DuCanhGH/next-pwa -- --depth=3000 --branch master --single-branch
  2. Create a new branch:

    git checkout -b MY_BRANCH_NAME origin/master
  3. Install the dependencies with:

    pnpm install
  4. cd into docs:

    cd docs
  5. Start developing:

    pnpm dev

    And then edit the content in docs/content. The app should automatically reflect the changes!

  6. When your changes are finished, commit them to the branch:

    git add .
    git commit -m "DESCRIBE_YOUR_CHANGES_HERE"
    
  7. When you are ready to push, make a fork and then run:

    git remote set-url origin https://github.com/YOURNAME/next-pwa
    git push