PermaplanT is a web app for planning permaculture.
- Browsers: Firefox, Chromium, Vivaldi, Edge, Opera
- RAM: >4GB for small places, >8GB for larger places
Start reading in /doc/architecture/README.md. The documentation is best viewed by running the following commands in the projects root folder:
make run-mdbookWhich will open /doc/architecture/README.md as first page.
The documentation is also hosted for PR/Development/Release:
| Branch | Backend Documentation (Cargo) | General Documentation (mdBook) | API Documentation (Swagger UI) | Frontend Documentation (Storybook) |
|---|---|---|---|---|
| Merge Request | cargodoc | mdbook | swaggerui | storybook |
| Development | cargodoc | mdbook | swaggerui | storybook |
| Master | cargodoc | mdbook | swaggerui | storybook |
| Production | cargodoc | mdbook | swaggerui | storybook |
Type make help to see all commands.
The Makefile consists of frequently used workflows.
For more detailed executions have a look inside the specific subfolders.
Some of the commands require env variables to be set. Have a look at backend env variables, frontend env variables and scraper env variables
Important links:
PermaplanT is developed by us and by users like you. We welcome both pull requests and issues on GitHub. Check out the contributing docs.
Information about developing can be found under our development setup.