Skip to content

Repository files navigation

Chalendia

Self-hosted online shop for small merchants: a Rust HTTP API, a Vue 3 storefront and back office, PostgreSQL for storage. Designed to run on the smallest server a merchant is willing to pay for.

Status: design phase. No application code yet — the product is being specified first. See docs/design/core.md for the product rules and docs/adr/ for the decisions behind them.

What it is meant to do

Sell physical products with variants, take card payments through Stripe Checkout or bank transfer, ship with a real carrier, issue invoices, and be installable by one docker compose up followed by a setup screen.

Scope of the first release is fixed in ADR-0004; everything outside it is deliberate.

Getting started (contributors)

just dev-setup   # once per clone: prerequisites, git hooks, .env
just dev-start   # database, migrations, API and dev server
just dev-stop    # stops all three

just dev-start prints the URLs it made available. just dev-status says what is running, just dev-logs follows the output, and just check runs every gate CI runs. Development ports avoid the usual ones so several projects can run on one machine; change them in .env.

Running it as an operator would

docker compose up -d   # the shop and its database, from the built image

Documentation

Where What
docs/design/ Product rules as observed by the user
docs/adr/ Project-level decisions with rationale
docs/backend/, docs/frontend/ Layer decisions and conventions
docs/git-workflow.md Branching, PRs, CI gates

License

GNU AGPL-3.0. You may run, modify and redistribute Chalendia freely; if you distribute it or offer a modified version over a network, your changes must be published under the same license. Chalendia is free of charge and always will be — donations are welcome and buy nothing but the author's time.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages