Copy page

Run Wocart locally

Locally, everything runs on Cloudflare's local runtime: the database, the media bucket and the key-value stores are files on your machine. You need no Cloudflare resources until you deploy.

1. Clone and install

Code
git clone https://github.com/bighadj22/codflow.git
cd codflow
npm ci

One install at the root covers the API server, the dashboard and the shared code. The storefront has its own install (step 3).

2. Copy the configuration

Each application ships an example of every file it reads. Copy them:

Code
cp .env.example .env

cd cod-server
cp wrangler.toml.example wrangler.toml
cp .dev.vars.example .dev.vars

cd ../cod-client-astro
cp wrangler.toml.example wrangler.toml
cp .dev.vars.example .dev.vars

Then set three values:

Everything else works as shipped. Configuration lists every value.

3. Set up the storefront

Code
cd ../cod-astro/theme-00
npm ci
cp .dev.vars.example .dev.vars

The example already holds the local store key the database setup creates in the next step, and the local API's address.

4. Create the database and the admin

Code
cd ../../cod-server
npm run db:setup:local

cd ../cod-client-astro
ADMIN_EMAIL=you@example.com ADMIN_NAME=You npm run seed:admin

db:setup:local applies every migration and creates the store: its API key, menus, default collections, legal pages and a shipping profile. seed:admin creates your dashboard account and prints its password and a merchant API key. Save them: they are shown once.

Running db:setup:local again changes nothing the store already has. Running seed:admin again for the same email gives that account a new password and a new API key: use it when you lose them.

5. Start the three applications

Run each in its own terminal:

Code
cd cod-server && npm run dev                      # API on http://localhost:8787
cd cod-client-astro && npm run dev                # dashboard on http://localhost:4321
cd cod-astro/theme-00 && npm run dev -- --port 4322   # storefront on http://localhost:4322

The dashboard and the storefront both default to port 4321, so one of them takes another port.

Sign in to the dashboard with the account from step 4. The API reference is served by the server at http://localhost:8787/api/docs.

The local data

The API server and the dashboard share one local database, kept in .wrangler-shared/ at the repository root. Delete that folder to start over, then run step 4 again.

Optional services

Each of these is off until you configure it, and the store works without it:

Run the tests

Code
cd cod-server && npm run typecheck && npm test
cd cod-client-astro && npm run typecheck && npm test
(cd cod-astro/theme-00 && npm ci && npm test)   # the storefront theme

The tests need no network and no credentials.