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

Improve Development setup and docs #1225

Open
4 tasks
horenso opened this issue Mar 27, 2024 · 0 comments · May be fixed by #1241
Open
4 tasks

Improve Development setup and docs #1225

horenso opened this issue Mar 27, 2024 · 0 comments · May be fixed by #1241
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@horenso
Copy link
Contributor

horenso commented Mar 27, 2024

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?
@horenso horenso added the documentation Improvements or additions to documentation label Mar 27, 2024
@hatchla hatchla moved this to In Progress in PermaplanT Mar 28, 2024
@hatchla hatchla linked a pull request Apr 3, 2024 that will close this issue
25 tasks
@hatchla hatchla moved this from In Progress to In Review in PermaplanT Apr 4, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
Status: In Review
Development

Successfully merging a pull request may close this issue.

2 participants