Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
domdinicola committed Dec 16, 2024
1 parent f90b85f commit a3e2912
Show file tree
Hide file tree
Showing 8 changed files with 290 additions and 3,453 deletions.
19 changes: 19 additions & 0 deletions docs/src/docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# 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 [email protected]
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 `[email protected]/password`
14 changes: 13 additions & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,16 @@ title: Documentation

Aurora is the official HOPE online registration tool, it is released as open source project, feel free to contribute and use it.

It has be development taking performance and security as main key points
It has been development taking performance and security as main key points

The strengths of Aurora are:

- Incredibly fast (reached 15.000 registrations per second)
- Security (supports both
- Powerful form builder
- Support complex validation logic
- Database level user defined per form unique keys
- Multilanguage
- Open and protected online registrations
- Straightforward architecture
- Custom form page (partner logos, header, footer, colors...)
1 change: 1 addition & 0 deletions docs/src/run/.pages
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
nav:
- Development: dev.md
- Config: config.md
7 changes: 7 additions & 0 deletions docs/src/run/config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Setup HOPE integration

- Add aurora_token in the user
- Add aurora_server in the Constance Config
- Fetch data from Aurora
- Associate Organizations to Business Areas
- Associate Projects to Programmes
3,186 changes: 0 additions & 3,186 deletions pdm.lock

This file was deleted.

5 changes: 0 additions & 5 deletions pdm.toml

This file was deleted.

26 changes: 13 additions & 13 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -87,31 +87,31 @@ docs = [

[tool.uv]
dev-dependencies = [
"black<23.0.0,>=22.1.0",
"black",
"coverage",
"django-stubs[compatible-mypy]<2.0.0,>=1.16.0",
"django-webtest<2.0.0,>=1.9.7",
"django-stubs[compatible-mypy]",
"django-webtest",
"factory-boy",
"flake8",
"flake8-html",
"freezegun<2.0.0,>=1.2.2",
"freezegun",
"ipython",
"isort<6.0.0,>=5.6.4",
"isort",
"pdbpp",
"pre-commit",
"pyflakes",
"pytest-asyncio",
"pytest-coverage<1.0,>=0.0",
"pytest-django<5.0.0,>=4.1.0",
"pytest-coverage",
"pytest-django",
"pytest-echo",
"pytest-html",
"pytest-pythonpath<1.0.0,>=0.7.3",
"pytest-selenium<3.0,>=2.0",
"pytest-variables<3.0",
"pytest-xdist>=3.6.1",
"pytest<7.2",
"pytest-pythonpath",
"pytest-selenium",
"pytest-variables",
"pytest-xdist",
"pytest",
"tox",
"watchdog<3.0.0,>=2.1.6",
"watchdog",
]

[build-system]
Expand Down
485 changes: 237 additions & 248 deletions uv.lock

Large diffs are not rendered by default.

0 comments on commit a3e2912

Please sign in to comment.