https://github.com/liqd/adhocracy-plus
adhocracy+ is a SaaS platform to make digital democracy easy for everyone
https://github.com/liqd/adhocracy-plus
Last synced: about 1 month ago
JSON representation
adhocracy+ is a SaaS platform to make digital democracy easy for everyone
- Host: GitHub
- URL: https://github.com/liqd/adhocracy-plus
- Owner: liqd
- License: agpl-3.0
- Created: 2019-10-24T10:03:57.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T08:11:54.000Z (over 1 year ago)
- Last Synced: 2024-10-29T09:27:56.169Z (over 1 year ago)
- Language: Python
- Homepage: https://adhocracy.plus/
- Size: 25 MB
- Stars: 78
- Watchers: 5
- Forks: 20
- Open Issues: 59
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - liqd/adhocracy-plus - adhocracy+ is a SaaS platform to make digital democracy easy for everyone (others)
- awesome-technostructure - liqd/adhocracy-plus - plus: adhocracy+ is a SaaS platform to make digital democracy easy for every ([🎓 research](https://github.com/stars/ketsapiwiq/lists/research))
README
# 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.
[](https://coveralls.io/github/liqd/adhocracy-plus?branch=main)
## Getting started
adhocracy+ is designed to make online participation easy and accessible to everyone. It can be used on our SaaS-platform or installed on your own servers. How to get started on our platform is explained [here](https://adhocracy.plus/info/start/).
## Installation for development
### Requirements
* nodejs (+ npm)
* python 3.x (+ venv + pip)
* libpq (only if postgres should be used)
* pillow-heif (required for macOS M1 Monterey and newer versions)
* libpq (only if PostgreSQL is used)
* postgis (only if PostgreSQL is used)
* libmagic (macOS)
* GDAL
* SpatiaLite [with JSON1 enabled](https://code.djangoproject.com/wiki/JSON1Extension) (only if SpatiaLite is used for local development)
* Redis (required in production, optional for development)
### Installing SpatiaLite
#### Ubuntu/Debian
```
sudo apt update && sudo apt install -y libsqlite3-mod-spatialite
```
#### macOS (with Homebrew)
```
brew update
brew install spatialite-tools
brew install gdal
```
For GeoDjango to be able to find the SpatiaLite library, add the following to a file you create at `adhocracy-plus/config/settings/local.py`:
```
SPATIALITE_LIBRARY_PATH = "/usr/local/lib/mod_spatialite.dylib"
```
If installing with homebrew, the path may need to instead be `/opt/homebrew/lib/mod_spatialite.dylib"`
You can find the exact location by running this command:
```
$ find /opt/homebrew -name "mod_spatialite*"
```
### MacOs .zshrc or .bashrc settings
The following variables should point to the correct paths, found by the `find` command above
Add the following to your `.zshrc` or `.bashrc`
```
export SPATIALITE_LIBRARY_PATH="/opt/homebrew/lib/mod_spatialite.dylib"
export PYTHON_CONFIGURE_OPTS="--enable-loadable-sqlite-extensions"
export LDFLAGS="-L/opt/homebrew/opt/sqlite/lib -L/opt/homebrew/lib"
export CPPFLAGS="-I/opt/homebrew/opt/sqlite/include -I/opt/homebrew/include"
export PKG_CONFIG_PATH="/opt/homebrew/opt/sqlite/lib/pkgconfig"
path+=(
$HOME
/opt/homebrew/opt/sqlite/bin
)
```
#### Pyenv
If you are using pyenv, you need to create your venv with the following command:
```
PYTHON_CONFIGURE_OPTS="--enable-loadable-sqlite-extensions" pyenv install 3.12.9 (with your version)
```
#### Libmagic (macOS)
In macOS, the dependency libmagic needs to be installed
```
brew install libmagic
```
### Adhocracy-plus software Installation
git clone https://github.com/liqd/adhocracy-plus.git
cd adhocracy-plus
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
## 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 our [contributing](./docs/contributing.md) document.
## Security
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
Add your DATABASE credentials to your `local.py` file -- create one in `adhocracy-plus/config/settings/` if it doesn't exist already.Once your local settings for the postgresql DATABASE are set, run the following command once:
```
make postgres-create
```
to start the test server with postgresql, run:
```
export DATABASE=postgresql
make postgres-start
make watch
```
If you encounter issues with creating/running postgresql from the make command, try to set it up manually with the steps explained in our [docs](./docs/postgresql.md).
### Use Celery for task queues
For a celery worker to pick up tasks you need to make sure that:
- 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:
```
make celery-worker-start
```
To inspect all registered tasks, list the running worker nodes, call:
```
make celery-worker-status
```
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)