Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) · 1.09 KB

How to contribute to flaskcwg.github.io

Setup Instructions

  • Fork the repo

  • Clone your forked repo

    git https://github.com/{username}/flaskcwg.github.io.git
    cd flaskcwg.github.io
  • Setup the upstream to original repo

    git remote add upstream https://github.com/flaskcwg/flaskcwg.github.io.git
  • Create a virtual env and activate it

    For Linux/Mac:

    python -m venv env
    source env/bin/activate

    For Windows:

    py -m venv env
    source env\Scripts\activate
  • install dependencies

    pip install -r requirements.txt
  • run static.py. This will build html content in docs/

    python static.py
  • run serve.py. Go to the IP address shown in the printout to view the generated site

    cd docs
    python serve.py
  • Add your fork as a remote to push your work to. Replace {username} with your username. This names the remote "fork", the default Pallets remote is "origin".