From 51448a0122f39ab14670d1beb330aacd4b1acecd Mon Sep 17 00:00:00 2001 From: Ricardo Date: Wed, 21 Aug 2024 10:23:00 +0200 Subject: [PATCH 1/7] Updates in the README --- README.md | 9 ++++++--- changelog/7978.md | 3 +++ 2 files changed, 9 insertions(+), 3 deletions(-) create mode 100644 changelog/7978.md diff --git a/README.md b/README.md index 06925d76d..973de68ba 100644 --- a/README.md +++ b/README.md @@ -13,17 +13,18 @@ adhocracy+ is designed to make online participation easy and accessible to every ### Requirements - * nodejs (+ npm) + * nodejs (+ npm) (Use Homebrew to reinstall the node in the projects folder runnign: brew install node) * 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 (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 @@ -40,7 +41,7 @@ adhocracy+ is designed to make online participation easy and accessible to every ### Use postgresql database for testing -run the following command once: +To use postgresql database in production run the following command once: ``` make postgres-create ``` @@ -57,7 +58,9 @@ Go to http://localhost:8004/ and login with admin@liqd.net | password For a celery worker to pick up tasks you need to make sure that: - the redis server is running + run: 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`) + To find local.py run: find . -name "local.py" To start a celery worker node in the foreground, call: ``` diff --git a/changelog/7978.md b/changelog/7978.md new file mode 100644 index 000000000..9bf68ec87 --- /dev/null +++ b/changelog/7978.md @@ -0,0 +1,3 @@ +### Changes in the README + +I added to the readme some notes and new comands that helped me with the installation of the a+ repository locally. \ No newline at end of file From 9de8e485896d027e9fca5827a9b1e119e68d6c00 Mon Sep 17 00:00:00 2001 From: Ricardo Date: Wed, 21 Aug 2024 16:00:22 +0200 Subject: [PATCH 2/7] New updates on README.md --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 973de68ba..70eb89598 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,12 @@ adhocracy+ is designed to make online participation easy and accessible to every ### Requirements - * nodejs (+ npm) (Use Homebrew to reinstall the node in the projects folder runnign: brew install node) + * 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 (for macOS M1 Monterey and newer versions) + * pillow-heif (required for macos M1 ...etc) ### Installation @@ -41,7 +41,7 @@ adhocracy+ is designed to make online participation easy and accessible to every ### Use postgresql database for testing -To use postgresql database in production run the following command once: +run the following command once: ``` make postgres-create ``` @@ -60,6 +60,7 @@ For a celery worker to pick up tasks you need to make sure that: - the redis server is running run: 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 tasks when calling code instead of schedulingmac them via the Redis broker.) To find local.py run: find . -name "local.py" To start a celery worker node in the foreground, call: @@ -76,6 +77,7 @@ To send a dummy task to the queue and report the result, call: ``` make celery-worker-dummy-task ``` +Check out our extensive [celery documentation](https://github.com/liqd/adhocracy-plus/compare/docs/celery.md?expand=1) ## Installation on a production system From 41591411e0ebe45ecd22936307fc5c8c227fa414 Mon Sep 17 00:00:00 2001 From: Ricardo Date: Tue, 27 Aug 2024 09:24:27 +0200 Subject: [PATCH 3/7] Latest changes in README --- README.md | 35 +++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 70eb89598..7eb1df855 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ adhocracy+ is designed to make online participation easy and accessible to every * 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 ...etc) + * pillow-heif (required for macOS M1 Monterey and newer versions) ### Installation @@ -39,6 +39,21 @@ adhocracy+ is designed to make online participation easy and accessible to every make watch +## 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. + + +## Advance settings + ### Use postgresql database for testing run the following command once: @@ -60,8 +75,8 @@ For a celery worker to pick up tasks you need to make sure that: - the redis server is running run: 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 tasks when calling code instead of schedulingmac them via the Redis broker.) - To find local.py run: find . -name "local.py" + (Celery's always_eager is disabled to ensure tests run tasks when calling code 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: ``` @@ -77,16 +92,4 @@ To send a dummy task to the queue and report the result, call: ``` make celery-worker-dummy-task ``` -Check out our extensive [celery documentation](https://github.com/liqd/adhocracy-plus/compare/docs/celery.md?expand=1) - -## 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 From 1788d1c821491678b1a9d50e948da187080b6aea Mon Sep 17 00:00:00 2001 From: Ricardo Date: Tue, 27 Aug 2024 15:43:24 +0200 Subject: [PATCH 4/7] Corrected typos in README and corrected cahngelog 7978.md to comply with best practices. --- README.md | 7 +++---- changelog/7978.md | 4 ++-- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7eb1df855..d9f477bb9 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,7 @@ adhocracy+ is designed to make online participation easy and accessible to every ### Start a local server make watch + Go to http://localhost:8004/ and login with admin@liqd.net | password ## Installation on a production system @@ -52,7 +53,7 @@ If you found an issue, want to contribute, or would like to add your own feature We care about security. So, if you find any issues concerning security, please send us an email at info [at] liqd [dot] net. -## Advance settings +## Advanced settings ### Use postgresql database for testing @@ -67,15 +68,13 @@ 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 run: 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 tasks when calling code instead of scheduling them via the Redis broker.) + 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: diff --git a/changelog/7978.md b/changelog/7978.md index 9bf68ec87..c9b9e51bb 100644 --- a/changelog/7978.md +++ b/changelog/7978.md @@ -1,3 +1,3 @@ -### Changes in the README +### Changed -I added to the readme some notes and new comands that helped me with the installation of the a+ repository locally. \ No newline at end of file +- Update README with some notes and new comands for the installation of the a+ repository locally. \ No newline at end of file From 9c94cd9544105539febc285e6bad408b04342174 Mon Sep 17 00:00:00 2001 From: Ricardo Date: Tue, 27 Aug 2024 17:14:15 +0200 Subject: [PATCH 5/7] Updates in the README and added link to technical documentation --- README.md | 16 +++++++++++----- changelog/7978.md | 2 +- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d9f477bb9..1d2e48a99 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # adhocracy+ +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.. [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). ![Build Status](https://github.com/liqd/adhocracy-plus/actions/workflows/django.yml/badge.svg) @@ -38,6 +39,7 @@ adhocracy+ is designed to make online participation easy and accessible to every ### Start a local server make watch + Go to http://localhost:8004/ and login with admin@liqd.net | password ## Installation on a production system @@ -50,7 +52,7 @@ If you found an issue, want to contribute, or would like to add your own feature ## Security -We care about security. So, if you find any issues concerning security, please send us an email at info [at] liqd [dot] net. +We take security seriously. If you find any security issues, please feel free to email us at info [at] liqd [dot] net. ## Advanced settings @@ -71,11 +73,15 @@ make watch ### Use Celery for task queues For a celery worker to pick up tasks you need to make sure that: -- the redis server is running - run: redis-cli ping (it should return: PONG) +- 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. +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: ``` diff --git a/changelog/7978.md b/changelog/7978.md index c9b9e51bb..09808e08a 100644 --- a/changelog/7978.md +++ b/changelog/7978.md @@ -1,3 +1,3 @@ ### Changed -- Update README with some notes and new comands for the installation of the a+ repository locally. \ No newline at end of file +- Update README with some notes and new commands for the installation of the a+ repository locally. \ No newline at end of file From faaa7d22fae27b233fe194adcf3c789668a796df Mon Sep 17 00:00:00 2001 From: Ricardo Date: Wed, 28 Aug 2024 11:47:32 +0200 Subject: [PATCH 6/7] README latest adjustments --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1d2e48a99..45dcd39b3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # adhocracy+ -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.. -[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) @@ -29,18 +28,18 @@ adhocracy+ is designed to make online participation easy and accessible to every 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 +``` +Go to http://localhost:8004/ and login with admin@liqd.net | password ## Installation on a production system From ac0e7411bf6f1c14aab072cb9d5bb6d3a7eae753 Mon Sep 17 00:00:00 2001 From: Ricardo Date: Wed, 28 Aug 2024 12:00:02 +0200 Subject: [PATCH 7/7] Updates README with better layout --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 45dcd39b3..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). 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. +[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) @@ -29,15 +29,15 @@ adhocracy+ is designed to make online participation easy and accessible to every ### Start virtual environment ``` - source venv/bin/activate +source venv/bin/activate ``` ### Check if tests work ``` - make test +make test ``` ### Start a local server ``` - make watch +make watch ``` Go to http://localhost:8004/ and login with admin@liqd.net | password @@ -47,7 +47,7 @@ You like adhocracy+ and want to run your own version? An installation guide for ## 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). +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