RegenWorks

RegenWorks is an agroforestry design and management platform. This repository contains the web app, backend API, shared database models, modelling code, and desktop packaging.

Repository Layout

• packages/isomorphic - SolidStart web app.
• packages/frontend - shared frontend components and client code.
• packages/backend - Express backend API.
• packages/db - shared Mongoose schemas.
• packages/modelling - agroforestry layout and geometry modelling.
• packages/gis-napi - native geometry addon.
• packages/desktop-electron - Electron desktop package.
• packages/desktop-tauri - Tauri desktop package.

Requirements

• Node.js 24. See .nvmrc.
• pnpm 11. See packageManager in package.json.
• Rust and wasm-pack for geometry/WebAssembly builds.
• MongoDB for backend development.

Getting Started

Docker Local Development

This is the easiest path for a fresh clone. It starts MongoDB locally in Docker and runs the backend plus web dev server without requiring staging or production database credentials.

docker compose up --build

Open the web app at http://localhost:10000. The backend is available at http://localhost:3001, and MongoDB is available at mongodb://localhost:27017. Application data is stored in the mongo-data Docker volume.

The default Docker setup intentionally leaves third-party service keys blank. Features backed by Auth0, Google Maps/geocoding, Resend, or Stripe may be limited until local development keys are provided. To provide optional local keys, copy .env.docker.example to .env.docker, fill in only development credentials, then run:

docker compose --env-file .env.docker up --build

Stop the stack with docker compose down. To also delete the local MongoDB volume, run docker compose down -v.

Native Local Development

Install dependencies:

pnpm install

Create local environment files from examples:

cp packages/backend/.env.example packages/backend/.env
cp packages/isomorphic/.env.example packages/isomorphic/.env

Run the web app:

pnpm --filter isomorphic dev

Run the backend:

pnpm --filter backend dev

Useful Checks

pnpm --filter isomorphic lint
pnpm --filter backend lint
pnpm --filter isomorphic build
pnpm --filter backend build

Security And Secrets

Do not commit .env files, private certificates, signing keys, API keys, database dumps, or generated build output. Before publishing this repository publicly, scan both the working tree and the full Git history with a history-aware scanner such as gitleaks or trufflehog, then rotate any credential that was ever committed.

License

RegenWorks is available under the MIT License.