Skip to content

Commit 70b2cfd

Browse files
committed
Add a quickstart for local development
1 parent c84106d commit 70b2cfd

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -397,6 +397,34 @@ This will trigger the [Release EQL](https://github.com/cipherstash/encrypt-query
397397

398398
## Developing
399399

400+
> [!IMPORTANT]
401+
> **Before you follow the quickstart* you need to have this software installed:
402+
> - [mise](https://mise.jdx.dev/) — see the [installing mise](#installing-mise) instructions
403+
> - [Docker](https://www.docker.com/) — see Docker's [documentation for installing](https://docs.docker.com/get-started/get-docker/)
404+
405+
Local development quickstart:
406+
407+
``` shell
408+
# Clone the repo
409+
git clone https://github.com/cipherstash/encrypt-query-language
410+
cd encrypt-query-language
411+
412+
# Install dependencies
413+
mise trust --yes
414+
415+
# Build EQL installer and uninstaller, outputting to release/
416+
mise run build
417+
418+
# Start a postgres instance (defaults to PostgreSQL 17)
419+
mise run postgres:up --extra-args "--detach --wait"
420+
421+
# Run the tests (defaults to PostgreSQL 17)
422+
mise run test
423+
424+
# Stop and remove all containers and networks
425+
mise run postgres:down
426+
```
427+
400428
### How this project is organised
401429

402430
Development is managed through [mise](https://mise.jdx.dev/), both locally and [in CI](https://github.com/cipherstash/encrypt-query-language/actions).

0 commit comments

Comments
 (0)