CONTRIBUTING.md

Contributing

Requirements

• Node.js
• NPM
• Git

Note that if you know what you are doing, you can also use other runtimes and package manager like Deno, Bun, PNPM or Yarn.

Clone the repository or fork the repository

git clone https://github.com/<username>/renkei
cd renkei

Where <username> is your GitHub's account user name. If only cloning from the official repository, replace <username> with aminnairi.

Install the dependencies

Dependencies from all of the workspaces defined in the package.json file will be installed and node_modules folders should appear for both the whole workspace, and each packages folder.

npm install

Example

Start the Node.js example server

This will start the application and listen to localhost:8000 for requests from the client.

npm -w example/node start

Start the Rect.js example server

This will start the application and listen to localhost:5173 for requests from the browser.

npm -w example/react start

Sites

Documentation

Start

npm -w sites/documentation start