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

Improve Development setup and docs #1225

@horenso

Description

@horenso

Right now we have three different ways to develop Permaplant:

  • Run the database and everything else locally (local)
  • Run the database and other services in Docker but backend+frontend locally (docker+local)
  • Run the devcontainer (devcontainer)

Devcontainer is tightly intergrated with VSCode but some devs prefer other editors/IDEs.
I prefer to run all services (database, but also optionally Nextcloud, Keycloak in Docker) but the frontend and backend loaclly.
Devcontainer messes up user permissions for me. @hatchla prefers jetbrains IDs.

It should be easy to understand these three ways and how to setup each.

  • Documentation is clear for the three options
  • Good Docker setup for docker+local
  • make install should not install python packages locally, this is ok for devcontainer and local but no for docker+local.
  • Can we delete the section about github code spaces? Does anyone use that?

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

Status

In Review

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions