From 7c64d6ada40b31fc0e42bf294fbb23d2cc87ddeb Mon Sep 17 00:00:00 2001 From: Stefano Apostolico Date: Wed, 25 Sep 2024 17:25:52 +0200 Subject: [PATCH] updates --- docs/components/aurora/.pages | 4 ++++ docs/components/aurora/setup.md | 2 +- docs/components/aurora/usage.md | 24 ++++++++++++++++++++++++ 3 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 docs/components/aurora/.pages create mode 100644 docs/components/aurora/usage.md diff --git a/docs/components/aurora/.pages b/docs/components/aurora/.pages new file mode 100644 index 0000000..f596b17 --- /dev/null +++ b/docs/components/aurora/.pages @@ -0,0 +1,4 @@ +nav: + - index.md + - Contributing: setup + - Usage: usage.md diff --git a/docs/components/aurora/setup.md b/docs/components/aurora/setup.md index 0cdc3e3..3e31300 100644 --- a/docs/components/aurora/setup.md +++ b/docs/components/aurora/setup.md @@ -1,4 +1,4 @@ -# Development Setup +# Contributing Prerequisites: diff --git a/docs/components/aurora/usage.md b/docs/components/aurora/usage.md new file mode 100644 index 0000000..f92c781 --- /dev/null +++ b/docs/components/aurora/usage.md @@ -0,0 +1,24 @@ +# Run + +To start working with Aurora you can: + + +### Build and use your docker + +After you have cloned the repo, be sure to have a Reddis and PostgreSQL server running on your machine + + export ADMIN_EMAIL=admin@example.com + export ADMIN_PASSWORD=password + export DATABASE_URL=postgres://postgres:@127.0.0.1:5432/aurora + export CACHE_URL=redis://127.0.0.1:6379/1?client_class=django_redis.client.DefaultClient + + cd docker + + make build run + + +### Use provided compose.yml + + docker compose up + +navigate to http://localhost:8000/admin/ and login using `admin@example.com/password`