Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/okfde/froide
Freedom Of Information Portal
https://github.com/okfde/froide
fragdenstaat
Last synced: 5 days ago
JSON representation
Freedom Of Information Portal
- Host: GitHub
- URL: https://github.com/okfde/froide
- Owner: okfde
- License: mit
- Created: 2011-05-04T12:20:51.000Z (over 13 years ago)
- Default Branch: main
- Last Pushed: 2024-04-10T07:23:32.000Z (7 months ago)
- Last Synced: 2024-04-14T14:46:11.973Z (7 months ago)
- Topics: fragdenstaat
- Language: Python
- Homepage:
- Size: 29.4 MB
- Stars: 341
- Watchers: 33
- Forks: 85
- Open Issues: 108
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-starred - okfde/froide - Freedom Of Information Portal (others)
README
# Froide
[](https://github.com/okfde/froide/actions?query=workflow%3A%22Froide+CI%22)
Froide is a Freedom Of Information Portal using Django 3.2 on Python 3.8+.
It is used by the German and the Austrian FOI site, but it is fully
internationalized and written in English.
## Development on Froide
After clone, create a Python 3.8+ virtual environment and install dependencies:
```
python3 -m venv froide-env
source froide-env/bin/activate
# Install dev dependencies
pip install -r requirements-test.txt
# Install git pre-commit hook
pre-commit install
```
### Start services
You can run your own Postgres+PostGIS database and Elasticsearch service or run them with [Docker](https://docker.com):
```
docker compose -f compose-dev.yaml up
```
This will start Postgres and Elasticsearch and listen on port 5432 and 9200 respectively. You can adjust the port mapping in the `compose-dev.yaml`.
### Setup database and search index, start server
If you need to adjust settings, you can copy the `froide/local_settings.py.example` to `froide/local_settings.py` and edit it. More steps:
```
# To initialise the database:
python manage.py migrate --skip-checks
# Create a superuser
python manage.py createsuperuser
# Create and populate search index
python manage.py search_index --create
python manage.py search_index --populate
# Run the Django development server
python manage.py runserver
```
### Run tests
Make sure the services are running.
```
# Run all tests
make test
# Run only unit/integration tests
make testci
# Run only end-to-end tests
make testui
```
### Development tooling
For Python code, we use ruff for linting and formatting. JavaScript, Vue and SCSS files are formatted and linted with ESLint and Prettier.
Make sure to have pre-commit hooks registered (`pre-commit install`). For VSCode, [we recommend some extensions](./.vscode/extensions.json)
```json
{
"eslint.format.enable": true,
"eslint.packageManager": "pnpm",
"vetur.format.defaultFormatter.css": "prettier",
"vetur.format.defaultFormatter.html": "prettier",
"vetur.format.defaultFormatter.js": "prettier-eslint"
}
```
### Upgrade dependencies
```
# with pip-tools
pip-compile -U requirements.in
pip-compile -U requirements-test.in
```
## Docs
[Read the documentation](http://froide.readthedocs.org/en/latest/) including a [Getting Started Guide](http://froide.readthedocs.org/en/latest/gettingstarted/).
Froide is supported by the [Open Knowledge Foundation Germany](http://www.okfn.de/) and [Open Knowledge Foundation International](http://okfn.org/).
## License
Froide is licensed under the MIT License.