PermaplanT is an app for
- Web: Firefox, Chromium
- Larger mobile devices like tablets: Progressive Web App (PWA) Android 9+
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.
Following commands exists:
run, test, build, clean
Following entities exist:
frontend, backend, mdbook, storybook
You can construct your commands now, e.g run-backend, test-mdbook, build-storybook or clean-backend
Type make help to see all commands
SOME OF THESE COMMANDS REQUIRE ENV VARIABLES, LOOK AT backend env variables or frontend 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.