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

08caa84 · Aug 10, 2023
Aug 5, 2023
Jul 23, 2023
Apr 30, 2023
Jun 6, 2023
Jan 26, 2023
Aug 10, 2023
Aug 1, 2023
Aug 8, 2023
Aug 10, 2023
Aug 7, 2023
Aug 10, 2023
Jul 28, 2023
Apr 11, 2023
Apr 4, 2023
Aug 5, 2023
Aug 8, 2023
Jan 26, 2023
Aug 5, 2023
Jul 28, 2023
Jul 25, 2023

Repository files navigation

PermaplanT

Build Status Open in Dev Containers

PermaplanT is an app for

  • Web: Firefox, Chromium
  • Larger mobile devices like tablets: Progressive Web App (PWA) Android 9+

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.

Makefile commands

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:

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.