diff --git a/README.md b/README.md index 06925d76d..f757b282d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # adhocracy+ -[adhocracy.plus](https://adhocracy.plus/) is a free Open-Source participation platform maintained and primarily developed by Liquid Democracy e.V.. It is based on [adhocracy 4](https://github.com/liqd/adhocracy4) and [Django](https://github.com/django/django). +[adhocracy.plus](https://adhocracy.plus/) is a free Open-Source participation platform maintained and primarily developed by Liquid Democracy e.V.. It is based on [adhocracy 4](https://github.com/liqd/adhocracy4) and [Django](https://github.com/django/django). The project's [technical documentation](https://liqd.github.io/adhocracy-plus/) currently is in progress. You are welcome to provide feedback by creating a GitHub issue. ![Build Status](https://github.com/liqd/adhocracy-plus/actions/workflows/django.yml/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/liqd/adhocracy-plus/badge.svg?branch=main)](https://coveralls.io/github/liqd/adhocracy-plus?branch=main) @@ -13,30 +13,48 @@ adhocracy+ is designed to make online participation easy and accessible to every ### Requirements - * nodejs (+ npm) + * nodejs (+ npm) * python 3.x (+ venv + pip) * libpq (only if postgres should be used) * sqlite3 [with JSON1 enabled](https://code.djangoproject.com/wiki/JSON1Extension) * redis (in production, not needed for development) + * pillow-heif (required for macOS M1 Monterey and newer versions) ### Installation git clone https://github.com/liqd/adhocracy-plus.git cd adhocracy-plus - make install + make install make fixtures ### Start virtual environment +``` +source venv/bin/activate +``` +### Check if tests work +``` +make test +``` +### Start a local server +``` +make watch +``` +Go to http://localhost:8004/ and login with admin@liqd.net | password - source venv/bin/activate +## Installation on a production system -### Check if tests work +You like adhocracy+ and want to run your own version? An installation guide for production systems can be found [here](./docs/installation_prod.md). - make test +## Contributing or maintaining your own fork -### Start a local server +If you found an issue, want to contribute, or would like to add your own features to your own version of adhocracy+, check out our [contributing](./docs/contributing.md) document. + +## Security - make watch +We take security seriously. If you find any security issues, please feel free to email us at info [at] liqd [dot] net. + + +## Advanced settings ### Use postgresql database for testing @@ -51,13 +69,18 @@ make postgres-start make watch ``` -Go to http://localhost:8004/ and login with admin@liqd.net | password - ### Use Celery for task queues For a celery worker to pick up tasks you need to make sure that: -- the redis server is running +- the redis server is running. Check it by running +``` +redis-cli ping +``` +it should return: PONG + - the celery config parameter "always eager" is disabled (add `CELERY_TASK_ALWAYS_EAGER = False` to your `local.py`) +Celery's always_eager is disabled to ensure tests run the celery tasks inline instead of scheduling them via the Redis broker. +local.py should be under adhocracy_plus/config/settings, create one if it doesn't exist. This file saves settings for local development. To start a celery worker node in the foreground, call: ``` @@ -73,15 +96,4 @@ To send a dummy task to the queue and report the result, call: ``` make celery-worker-dummy-task ``` - -## Installation on a production system - -You like adhocracy+ and want to run your own version? An installation guide for production systems can be found [here](./docs/installation_prod.md). - -## Contributing or maintaining your own fork - -If you found an issue, want to contribute, or would like to add your own features to your own version of adhocracy+, check out [contributing](./docs/contributing.md). - -## Security - -We care about security. So, if you find any issues concerning security, please send us an email at info [at] liqd [dot] net. +Check out our extensive [celery documentation](https://github.com/liqd/adhocracy-plus/compare/docs/celery.md?expand=1) \ No newline at end of file diff --git a/changelog/7978.md b/changelog/7978.md new file mode 100644 index 000000000..09808e08a --- /dev/null +++ b/changelog/7978.md @@ -0,0 +1,3 @@ +### Changed + +- Update README with some notes and new commands for the installation of the a+ repository locally. \ No newline at end of file