Development Guide

We welcome everyone to open Pull Requests for waline! 🎉

If you want to contribute to waline, here is a guide.

Preparation

1. Use Git to clone the project

   git clone https://github.com/walinejs/waline.git

2. Installation dependencies

   Warning

   Install and use pnpm to install dependencies.

   npm i -g pnpm@latest

   cd waline
   pnpm i

Development

• Run pnpm client:dev to start @waline/client devServer

  Tips

  Since waline is based on Client/Server architecture, when debugging a client, you need to set SERVERURL, or start server devServer below at the same time and use the default localhost:9090.

• Run pnpm server:dev to start @waline/server devServer

  Tips

  In order to run @waline/server locally, you need to configure some local environment variables to example/.env.

  We provide an example for you in example/.env.example.