Setting up and getting started

This page can be used to help developers with setting up the project in their local environment.

Setting up the project in your computer

Caution: Follow the steps in the following guide precisely. Things will not work out if you deviate in some steps.

First, fork the project repo, and clone the fork into your computer.

(Example) Steps to setup the project environment:

  1. Download packages: Run npm install to download the required packages.
  2. Run setup commands: Run commands needed to setup the project.
    Note: Remember to run commands from the appropriate directory.
  3. Configure files: Edit config files according to your needs. For example, changing the appTitle in config.js to match your project name.
  4. Verify the setup (optional):
    1. Run the build and serve commands, ensuring that the site properly deploys on your local host.
    2. Run the tests to ensure they all pass.

Before writing code

  1. Configure the coding style

    Configure your VSCode or IDEA checkstyle to allign with the project's coding style.

    Tip: You can easily customize your IDE's coding style through settings.

  2. Set up CI

    This project comes with a GitHub Actions config files (in .github/workflows folder). When GitHub detects those files, it will run the CI for your project automatically at each push to the master branch or to any PR. No set up required.

  3. Learn the design

    When you are ready to start coding, we recommend that you get some sense of the overall design by reading about ProjectEx’s architecture.

  4. Do the tutorial

    The Tracing Code tutorial can help you get acquainted with the codebase.