Skip to content
This repository has been archived by the owner on Apr 24, 2024. It is now read-only.

ElektraInitiative/PermaplanT

Folders and files

NameName
Last commit message
Last commit date

Latest commit

author
Moritz Schalk
Apr 22, 2024
2d44adc · Apr 22, 2024
Mar 14, 2024
Apr 15, 2024
Dec 17, 2023
Jun 6, 2023
Jan 26, 2023
Apr 22, 2024
Dec 18, 2023
Apr 20, 2024
Apr 21, 2024
Apr 11, 2024
Apr 22, 2024
Mar 28, 2024
Apr 11, 2023
Apr 4, 2023
Dec 17, 2023
Dec 16, 2023
Dec 15, 2023
Jan 26, 2023
Apr 5, 2024
Apr 5, 2024
Dec 17, 2023
Feb 14, 2024
Feb 14, 2024

Repository files navigation

PermaplanT

Build Status Open in Dev Containers

PermaplanT is a web app for planning permaculture.

Client Requirements

  • Browsers: Firefox, Chromium, Vivaldi, Edge, Opera
  • RAM: >4GB for small places, >8GB for larger places

Documentation

Start reading in /doc/architecture/README.md. The documentation is best viewed by running the following commands in the projects root folder:

make run-mdbook

Which 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)
Pull Request cargodoc mdbook swaggerui storybook
Development cargodoc mdbook swaggerui storybook
Production cargodoc mdbook swaggerui storybook

Makefile commands

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:

Community and Contributing

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.