Run your own shop with an admin, a themeable storefront, hosted checkout, a typed API and webhooks, and extend it with
out-of-process apps. No code or CLI needed for day-to-day selling.
- Admin: products, collections, orders, discounts, shipping, taxes, staff and settings in the browser
- Storefront: a bundled Astro storefront with Liquid themes (Shopify-style object names, but themes are ported to ShopNex's format, not drop-in), or bring your own through the typed REST Storefront API (Shopify-style naming, not GraphQL)
- Hosted checkout: shipping rates, payment methods, discount codes, order confirmation
- Extensible: scoped API tokens, signed webhooks, embedded apps and an app marketplace. No third-party code in the core
- Multi-tenant underneath: one shop by default, many shops by flipping
TENANCY_MODE
Why ShopNex
- No platform fees. MIT licensed, with no monthly plan and no cut of your sales. You pay your host and your payment processor.
- You own your data. Everything lives in your PostgreSQL database on your server.
- Built for merchants, not just developers. Day-to-day selling happens in the browser admin;
.env holds infrastructure only.
- One command to run.
docker compose up starts the admin, storefront and migrations.
- Familiar themes. Liquid templates with Shopify-style object names. Themes are ported to ShopNex's format rather than drop-in, so check the bundled ones for the structure.
- Agency friendly. Run many shops from one install with
TENANCY_MODE.
- Extend without forking. Apps run out of process through scoped API tokens and signed webhooks.
Status
ShopNex is pre-1.0 and releases often. See the roadmap for what's done and what's next, and the
releases for what changed. Pin SHOPNEX_VERSION in production.
Quick start
Requires Docker.
curl -fsSLO https://raw.githubusercontent.com/shopnex-ai/shopnex/main/deploy/docker-compose.yml
docker compose up
Open http://localhost:3000 once the logs settle and follow the setup wizard to create the owner account.
Ctrl+C stops it; add -d (docker compose up -d) to keep it running in the background.
Anyone who reaches a fresh install can claim it, so finish setup right after deploying.
No .env needed. For a public server, set DOMAIN (HTTPS for the shop, plus stripe. and cj. subdomains for the
apps, all pointing at the server) and pin SHOPNEX_VERSION to a release tag; see the self-hosting guide.
Development
Requires Node (see .node-version), pnpm and PostgreSQL.
pnpm install
cp .env.example .env # set the database URL and app secret
pnpm db:migrate
pnpm dev # admin on :3000, storefront on :4321
Documentation
Guides live in apps/docs (pnpm dev:docs, http://localhost:3400). Developer reference is in docs/:
| Doc | Covers |
|---|
| Development | Env setup, pnpm dev options, local ports, OAuth sign-in, end-to-end tests |
| Architecture | Repository layout, API layout, admin routes, tenancy |
| Storefront API | Building an external storefront with @shopnex/storefront-sdk |
| Apps and marketplace | API tokens, building apps with @shopnex/app, embedded apps, marketplace |
| Webhooks | Topics, signatures, delivery and retries |
| Roadmap | What's done and what's next |
| Releasing | How to cut a release |
Community
Chat with the team and other users on Discord, or post questions and ideas in
GitHub Discussions.
Contributing
Issues and pull requests are welcome: see CONTRIBUTING.md. Report security issues privately,
as described in SECURITY.md.
See @shopnex/app for building apps with no database or OAuth code: authenticate,
Admin API, per-shop data, signed requests (@shopnex/app/store), and admin-styled UI (@shopnex/app/ui).
License
MIT
