xanonymous-github / eveg

group project of HCI course (CS916)

CS916 Social informatics project

E-Veg website

The production version of this project is deployed on https://eveg.xcc.tw/ It is automatically built from the main branch.

Get started

First time setup

Since this is a project of a homework nature, in addition to the recommended environment configuration and settings, a simplified version of the approach is also listed here. However, please note that using the simplified version of the configuration may not be able to use most features properly, such as Bootstrap, because the Bootstrap in this project is configured based on a standard web project.

Recommended steps

1. Install latest version of Node.js. You can follow the instructions on the node.js install guide.

2. Install PNPM. You can follow the instructions on the pnpm install guide.

3. Clone this repository.

   # Clone with SSH (recommended)
   git clone [email protected]:Xanonymous-GitHub/eveg.git

   # Clone with HTTPS
   git clone https://github.com/Xanonymous-GitHub/eveg.git

4. Install dependencies. Move to the project directory and run the following command.

   pnpm i

   • N.B pnpm may not be installed. If you have npm, you can simply run:

     npm install -g pnpm

   • Or, with homebrew or scoop:

     brew install pnpm
     scoop install nodejs-lts pnpm

Simple steps

1. Clone this repository (described above).
2. Use VSCode to open the project directory.
3. Install the Live Server extension.

Start development

Recommended steps

In the recommended steps, you need to run the following command to start the development server.

pnpm dev

then open the browser and go to http://localhost:5173.

Tip

Confirm the port number displayed in the URL after executing the command. It may not be 5173.

Okay, enjoy your development with hot reload and other features.

Simple steps

If you choose the simple steps, you can use the Live Server extension to start the development server. Open the index.html file in the project directory with VSCode, then click the Go Live button in the lower right corner of the VSCode status bar.