External/5chan
1
0
Fork 0
mirror of https://github.com/bitsocialnet/5chan.git synced 2026-08-03 07:41:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs(setup): pin Node 22.12.0 and document Corepack workflow

Browse Source
This commit is contained in:
Tommaso Casaburi
2026-03-19 14:23:08 +08:00
parent f342179f1a
commit 4e29707522
2 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.nvmrc
+1
View File
@@ -0,0 +1 @@
22.12.0
README.md
+9 -4
View File
@@ -89,14 +89,19 @@ To have your board appear in a directory on the 5chan homepage:
### Prerequisites
- Node.js v22 (Download from https://nodejs.org)
- Corepack enabled for Yarn 4: `corepack enable`
- Portless is installed with project dependencies via `corepack yarn install`
- Node.js 22.12.0, pinned in [`.nvmrc`](./.nvmrc)
- Corepack enabled once per machine: `corepack enable`
### Contributor Setup
1. Run `nvm install && nvm use`
2. Run `corepack enable` once
3. Use plain `yarn install`, `yarn build`, and `yarn test`
### Setup
1. Clone the repository
2. Install dependencies: `corepack yarn install`
2. Install dependencies: `yarn install`
3. Start the web client: `yarn start`
The dev server runs at http://5chan.localhost:1355 via [Portless](https://port1355.dev/), which gives each Bitsocial project a stable, named URL instead of a random port. To bypass Portless and use a plain Vite dev server: `PORTLESS=0 yarn start`