Quick start
npm i septicAdd a septic block to poops.json:
{
"septic": {
"db": "data/app.db",
"auth": { "seed": { "email": "you@example.com", "password": "changeme", "role": "admin" } },
"resources": {
"notes": {
"methods": ["GET", "POST", "PUT", "DELETE"],
"access": { "read": "public", "write": "admin" },
"fields": { "title": "string required", "body": "text" }
}
}
}
}Serve it:
npx septic serve # http://localhost:3000Generated routes (only the methods you list):
| Method | Route | Gate |
|---|---|---|
| GET | /api/notes (?limit=&offset=&sort=&<col>=) |
access.read |
| GET | /api/notes/:id |
access.read |
| POST | /api/notes |
access.write |
| PUT | /api/notes/:id |
access.write |
| PATCH | /api/notes/:id (mounts with PUT, so it needs no methods entry) |
access.write |
| DELETE | /api/notes/:id |
access.write |
Log in with POST /api/_auth/login {email, password} (sets a signed session cookie), then write.
Build a static site from the data with npx septic build (see the poops bridge).
Next
- Config & field DSL — every type, flag, resource option and query parameter.
- Forms & the poops bridge — generated forms that submit, and rows compiled into pages.
- A todo manager or a blog — the same steps end to end, backend side.
- Site and API under one host, one command: laxative.
septic serveis the API alone.