Skip to content

HOW_TO_RUN-en.md

Latest commit

 

History

History
68 lines (57 loc) · 5.05 KB

HOW_TO_RUN-en.md

File metadata and controls

68 lines (57 loc) · 5.05 KB
Raw

How to Run the Project

This document explains how to use the provided scripts to start this project on different operating systems.

Windows Users

  1. Ensure you have Node.js installed (LTS version recommended). The script will check automatically, but pre-installing can prevent interruptions.
  2. Double-click the start-project-en.bat file located in the project's root directory.
  3. The script will automatically check for the required node, npm, and pnpm.
    • If node or npm is not installed, the script will prompt you to install them, and you will need to re-run the script afterwards.
    • If pnpm is not installed, the script will ask if you want to install it globally via npm. Enter Y and press Enter to proceed with the installation.
  4. Once the installation checks pass, the script will automatically execute pnpm install to install project dependencies.
  5. Then, it will execute pnpm dev to start the development server.
  6. The terminal will display the development server's address (usually http://localhost:xxxx).
  7. How to stop the server: In the command prompt window where the script is running, press CTRL+C, then confirm if prompted, to stop the development server.

macOS Users

  1. Ensure you have Node.js installed (LTS version recommended). You can download it from the official website or use Homebrew (brew install node).
  2. Open your Terminal.
  3. Navigate to the project's root directory. For example, if your project is in ~/Projects/swot, type cd ~/Projects/swot.
  4. Before running the script for the first time, you need to give it execution permissions. Run the following command in the terminal: 
    chmod +x start-project-macos-en.sh
  5. Now, you can run the script: 
    ./start-project-macos-en.sh
  6. The script will automatically check for the required node, npm, and pnpm.
    • If node or npm is not installed, the script will prompt you to install them. You will then need to close the current terminal, open a new one, and re-run the script.
    • If pnpm is not installed, the script will ask if you want to install it globally via npm. Enter y and press Enter to proceed.
  7. Once the installation checks pass, the script will automatically execute pnpm install.
  8. Then, it will execute pnpm dev to start the development server.
  9. The terminal will display the development server's address (usually http://localhost:xxxx).
  10. How to stop the server: In the terminal window where the script is running, press CTRL+C to stop the development server.

Linux Users

  1. Ensure you have Node.js installed (LTS version recommended). You can download it from the official website or use your distribution's package manager (e.g., apt, dnf, pacman).
  2. Open your terminal.
  3. Navigate to the project's root directory.
  4. Before running the script for the first time, you need to give it execution permissions. Run the following command in the terminal: 
    chmod +x start-project-linux-en.sh
  5. Now, you can run the script: 
    ./start-project-linux-en.sh
  6. The script will automatically check for the required node, npm, and pnpm.
    • If node or npm is not installed, the script will prompt you to install them. You will then need to close the current terminal, open a new one, and re-run the script.
    • If pnpm is not installed, the script will ask if you want to install it globally via npm. Enter y and press Enter to proceed.
  7. Once the installation checks pass, the script will automatically execute pnpm install.
  8. Then, it will execute pnpm dev to start the development server.
  9. The terminal will display the development server's address (usually http://localhost:xxxx).
  10. How to stop the server: In the terminal window where the script is running, press CTRL+C to stop the development server.

Notes

  • If, after installing pnpm, the script fails to find the pnpm command in the same session, try closing the current terminal/command prompt window, opening a new one, and then re-running the startup script. This is often because the path to the newly installed command has not yet been recognized in the current session.
  • All interactive prompts in these scripts are in English.
  • If you encounter any issues, check the error messages output in the terminal; they usually provide clues for resolving the problem.

Important Notes

  • Running the project using the scripts described above will start the development version. The development version typically includes features like hot-reloading and detailed error outputs, which are helpful for development but not suitable for a production deployment.
  • If you intend to build the project (e.g., to generate optimized files for a production environment), this usually involves different commands and configurations (e.g., pnpm build). Please familiarize yourself with the project's build process and related concepts before proceeding.