Add README

This commit is contained in:
Jannis Portmann 2023-04-01 12:13:55 +02:00
parent b9a09131bc
commit 3eec440abe

34
README.md Normal file
View file

@ -0,0 +1,34 @@
# Pflänz.li
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
## 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/)
- [MariaDB](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 |
|--------------|---------------|------------|
| Indoor only | `boolean` | checkbox |
| Name | `string` | textfield |
| Category | `Category` | dropdown |
## Development
To get started with development, see [DEVELOPMENT.md](DEVELOPMENT.md)