eddy/wwebjs-api
Watch
1
0
Fork
You've already forked wwebjs-api
 0
Code Issues 1 Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

docs: explain public image and reproducible build

Browse source
This commit is contained in:
Eddy de Vink 2026-08-18 10:08:37 +02:00
commit 9ee80f4367
1 changed files with 11 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -114,40 +114,38 @@ does not download an unpatched upstream `main` branch.
## Run Locally ## Run Locally
1. Clone the repository: Clone the public Forgejo repository:
```bash ```bash
git clone https://github.com/avoylenko/wwebjs-api.git git clone https://git.eddydevink.nl/eddy/wwebjs-api.git
cd wwebjs-api cd wwebjs-api
``` ```
2. Install the dependencies: Install dependencies for local Node.js development:
```bash ```bash
npm install npm ci
``` ```
**Note:** To use the latest edge version of whatsapp-web.js directly from GitHub (with the latest features and fixes), modify the `package.json` dependency: The dependency is pinned to the patched `whatsapp-web.js` archive in
`vendor/`. Do not replace it with upstream `main` when testing this fix.
```json For the recommended container workflow, use the public image or the
"whatsapp-web.js": "github:pedroslopez/whatsapp-web.js#main" reproducible local build described above.
```
Then run `npm install` again. Be aware that edge versions may contain unstable features. Copy the environment template and configure the required values:
3. Copy the `.env.example` file to `.env` and update the required environment variables:
```bash ```bash
cp .env.example .env cp .env.example .env
``` ```
4. Run the application: Run the application:
```bash ```bash
npm run start npm run start
``` ```
5. Access the API at `http://localhost:3000` The API is available at `http://localhost:3000` by default.
## Testing ## Testing