diff --git a/README.md b/README.md new file mode 100644 index 0000000..82ff2c7 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# plant-exchange + +## Idea +A platform where people can exchange plants. They can post what they have and search for others with [filters](#filters). + +## Tech stack +- [Symfony](https://symfony.com/) +- [PostgreSQL](https://www.postgresql.org/), maybe should be using MySQL for easier deployment? + +Deployment: TBD + +## Admin dashboard +Find it under `/admin` + +## Filters +: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 | + +Distance from entered ZIP to the offering ZIP. \ No newline at end of file