From 3eec440abe1d98ee42a9deeef907ff1c0e7f9c17 Mon Sep 17 00:00:00 2001 From: Jannis Portmann Date: Sat, 1 Apr 2023 12:13:55 +0200 Subject: [PATCH] Add README --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..efae634 --- /dev/null +++ b/README.md @@ -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) \ No newline at end of file