Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.3 KB

Development.md

File metadata and controls

56 lines (37 loc) · 1.3 KB
  • Step 1. Install PDM

    The project uses PDM for managing dependencies, executing commands, and other stuff. Follow the instructions to install PDM if you haven't.

  • Step 2. Clone the project

    git clone [email protected]:laike9m/Python-Type-Challenges.git
  • Step 3. Install dependencies

    # Inside the project directory
    pdm install && pdm install --plugins
    pdm venv activate
    pre-commit install

Common commands

  • Run test

    pdm test
    
  • Format files

    pdm format
    

    Note: The project uses djhtml to format HTML, which may conflicts with your editor's default formatter.

  • Start a development server

    pdm dev
    

    Then visit http://127.0.0.1:5000/ to access the app in your local browser.

  • Update dependencies

    # Use pdm to manage dependencies
    pdm add markdown
    
    # Sync changes with requirements.txt after update
    pdm export --prod --without-hashes > requirements.txt
    

    You may also want to use pdm-autoexport extension, it sync the dependencies to other formats automatically.

If you encounter any issues in the above steps, please file a bug and I'll fix it as soon as I can.