46 lines
1.7 KiB
Markdown
46 lines
1.7 KiB
Markdown
# Pflänz.li
|
|
|
|
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
|
|
[![Build Status](https://drone.thisfro.ch/api/badges/pflaenz.li/pflaenz.li/status.svg?ref=refs/heads/main)](https://drone.thisfro.ch/pflaenz.li/pflaenz.li)
|
|
|
|
## Idea
|
|
A platform where people can trade their plants. You can post what you have and search for others with [filters](#filters). The aim is to make it easier to trade plants and collect as few data as possible. Only the email/username and a postal code is required.
|
|
|
|
## Tech stack
|
|
- [Django](https://djangoproject.com/)
|
|
- [Postgres](https://www.postgresql.org/)
|
|
|
|
## Admin dashboard
|
|
Find it under `/admin`
|
|
|
|
## Filters
|
|
|
|
### Implemented
|
|
- Distance between postal codes
|
|
- Search within title
|
|
|
|
### Ideas
|
|
It would be nice to have categories somehow, but it would be hard to make it comprehensive.
|
|
|
|
:warning: This list is work in progress!
|
|
|
|
Searching with filters such as:
|
|
| Filter Name | Type | Input type |
|
|
|--------------|---------------|------------|
|
|
| Distance | `int` | numfield |
|
|
| ZIP code | `int` | numfield |
|
|
| Name | `string` | textfield |
|
|
| Category | `Category` | dropdown |
|
|
|
|
## Setup
|
|
When deploying, don't forget to pull the PLZ index and save it to the database using
|
|
```
|
|
python manage.py getplzindex --force
|
|
```
|
|
|
|
## Development
|
|
To get started with development, see [DEVELOPMENT.md](DEVELOPMENT.md)
|
|
|
|
## Open Source Data
|
|
For calculating distances between zip codes, the `Official index of cities and towns including postal codes and perimeter ` is used.
|
|
Source: https://opendata.swiss/en/dataset/amtliches-ortschaftenverzeichnis-mit-postleitzahl-und-perimeter |