Cette page n’est disponible qu’en anglais.
Financy docs
How to run, build on and deploy Financy. The same guides as the repository's docs folder, kept in step with main.
New to Financy?
Run your own copy of Seed on your machine in four commands, and open the product at http://app.localhost.
Get startedGet started
- Building a product on SeedStart a product, take Seed's later changes, give back to Seed.
- Start a product: what belongs to Seed's own websiteWhat a new product deletes, replaces or sets.
- Run the local stackRun Seed on your machine with demo data, and reset it.
- Add your first featureA new kind of record, from the database to the screen.
- Work with an AI agentHave an AI agent create a product from Seed, add features and check its work.
Guides
- Deploy to a serverFrom a fresh server to a healthy deployment with HTTPS.
- Deploy an updateEvery deploy after the first, and rolling back.
- HTTPS certificatesHow each host gets its certificate, and retrying one.
- Give operators accessThe first administrator, roles, and opening Grafana.
- Run several projects on one serverProducts that share one server and one Traefik.
- Publish a releaseA version tag publishes the images to Docker Hub.
- BackupsTurn on the daily backup, and rehearse it.
- Restore from a backupBring back the database, the files and the push keys.
- Sign in with Google and GitHubRegistering the providers and what a person gets.
- Guest accounts"Try it now" without signing up, keeping the account, the limits and the clean-up.
- Set up billingPaid plans through Stripe, test mode first, then live.
- Plans and limitsChange a plan, add one, or add a limit a plan sells.
- Billing for operatorsThe admin panel's Billing pages, transfers, and Stripe's dashboard.
- The file storeGarage or another S3 store, its settings and the upload budget.
- Add file uploads to a featureUpload and download files from a feature, and have photos made safe and small.
- A person's data exportDownload my data, what the ZIP holds and how it expires.
- The catalogA shop's items with photos, colours and sizes, edited in the admin panel.
- Telegram botBotFather, the webhook, linking a chat, and adding a product's commands.
- Offline in the SPATurn the offline layer or the WebSocket module off, or remove them.
- The aggregate referenceEvery file of the notes aggregate, in order.
- Make an aggregate work offlineRead, and write, an aggregate with no network.
- Link two aggregatesOne aggregate naming another, with tags and notes as the example.
- Delete, move and export an aggregateRestore after delete, a move to another group, and the data export.
- Connect a feature to the appGroup settings, the overview, the inbox and the rest of the app.
- Admin modulesThe operator area as a list of modules, and how to add one.
- Run the load testsRun the k6 scenarios and build a large test group.
- Run the browser testsThe Playwright specs in e2e/, and which of them CI runs.
Concepts
- The three appsThe SPA, the admin app and the public website, and how to deploy each.
- IdsEvery id is a UUID version 7.
- CapacityHow many users one server carries.
- Trials, failed payments and cancellingA group's plan from checkout to cancellation, and its mails.
- How offline reads workWhat the SPA keeps on the device and how it reads offline.
- How offline writes syncHow a change made offline reaches the server, or is refused.
- Sign-out and the device's dataWhat the SPA deletes, and keeps, when a person signs out.
- The app shellHow the service worker starts the app with no network.
- Note attachments and profile picturesFiles kept on a note, and a person's picture in place of their initials.
- One large groupHow one group behaves from a thousand notes to a million.
Reference
- Every taskEvery deno task, what it does and where it is explained.
- SettingsEvery variable of the env file.
- API errorsThe one error body every failed API answer has.
- Security headersThe headers every answer of the API, SPA and MPA sends.
- API referencePersonal API tokens and the notes endpoints, with examples.