Skip to content

Add a Quick start guide and usage section #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
imanimanyara merged 1 commit into from
Oct 4, 2026
Merged

Add a Quick start guide and usage section #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,36 @@ Add engines with profiles:
make up PROFILES=pg,mysql,mongodb,ui
```

## Quick start guide and usage

### Getting started

1. Confirm the harness is sound: `make verify-structure`.
2. Start only the engines a project needs (profiles are opt-in, one per engine):
`make up PROFILES=pg,ui`.
3. Check what is running: `make status`.

### Usage

Provision a project: a database, a least-privilege owner role, a read-only
companion role, the configured extensions, and a paste-ready connection block:

```bash
make new-project NAME=myapp
make new-project NAME=myapp ENGINE=mysql
```

Connect, and back up:

```bash
make psql USER_NAME=myapp # as the project role
make backup ENGINE=pg DB=myapp # one database
make verify-backups # restore them into throwaway containers
```

The full walkthrough is in [Getting started](docs/getting-started.md); everything
else is in the [documentation index](#documentation).

## Engines

Every engine is **authenticated by default**, which several of them are not out
Expand Down
Loading