1.
Architecture
❱
1.1.
Goals
1.2.
Constraints
1.3.
Context & Scope
1.4.
Solution Strategy
1.5.
Building Block View
1.6.
Runtime View
1.7.
Deployment
1.8.
Crosscutting Concepts
1.9.
Architecture Decisions
1.10.
Quality
1.11.
Risks and Technical Debt
1.12.
Glossary
2.
Authors
3.
PermaplanT Backend
❱
3.1.
Setup
3.2.
How to obtain access tokens?
3.3.
API documentation
3.4.
HTTP Headers
3.5.
Cronjobs
3.6.
Performance Benchmarks
3.7.
06updating_schema_patch
3.8.
Steps to add a Field to Entities
3.9.
08import_sql_files
3.10.
Troubleshooting
4.
CI/CD Pipeline
5.
Contributing to PermaplanT
❱
5.1.
Contributing to Backend
5.2.
Contributing to Frontend
5.3.
GitLab CLI Configuration
5.4.
Labels
5.5.
Gem
5.6.
Useful Command-line Tools
5.7.
Regular Tasks for Weekly Meeting
6.
Database
❱
6.1.
Application Settings
6.2.
Cronjobs
6.3.
Hierarchy
6.4.
Importing Database dumps
6.5.
Recovering Deleted Maps or Layers
6.6.
Schemata
❱
6.6.1.
ER diagram
6.6.2.
Enum Types
6.6.3.
Table descriptions
7.
Decision Process
❱
7.1.
EXPLANATIONS
7.2.
TEMPLATE
7.3.
Authentication & Authorization
7.4.
Backend API documentation
7.5.
Mail Client for the Backend
7.6.
Backend ORM/SQL Crate
7.7.
Backend Programming Language
7.8.
Backend Web Framework
7.9.
Backend Testing Strategy
7.10.
Backend Web Framework
7.11.
Canvas Dependency Resolution
7.12.
CI/CD
7.13.
Database
7.14.
Database Plant Hierarchy
7.15.
Drawing Library
7.16.
Example Migrations
❱
7.16.1.
Normalized Plants and Ranks
❱
7.16.1.1.
2023-04-07-130215 Plant Relastionships
❱
7.16.1.1.1.
down.sql
7.16.1.1.2.
up.sql
7.16.1.2.
example_queries.sql
7.16.2.
One Table Per Taxonomy
❱
7.16.2.1.
2023-03-09-194135 Plant Relations
❱
7.16.2.1.1.
down.sql
7.16.2.1.2.
up.sql
7.16.3.
Taxonomy Ranks And Concrete Plants
❱
7.16.3.1.
2023-04-04-220813 Taxons
❱
7.16.3.1.1.
down.sql
7.16.3.1.2.
up.sql
7.16.3.2.
2023-04-04-220921 Plant Relationships
❱
7.16.3.2.1.
down.sql
7.16.3.2.2.
up.sql
7.16.3.3.
2023-04-07-112305 Varieties
❱
7.16.3.3.1.
down.sql
7.16.3.3.2.
up.sql
7.16.3.4.
example_queries.sql
7.17.
Frontend Architecture Pattern
7.18.
Frontend Build Tool
7.19.
Frontend Documentation
7.20.
E2E Testing
7.21.
Frontend Editor
7.22.
Frontend Keyhandling
7.23.
Frontend Lazyloading
7.24.
Frontend API Mocking Tool
7.25.
Frontend Offloading
7.26.
Frontend Programming Language
7.27.
Frontend State Management
7.28.
Timeline: Custom Date Picker Implementation Decision
7.29.
Frontend Timeline Date Picker
7.30.
Frontend UI Framework
7.31.
Map Undo/Redo Implementation
7.32.
Nextcloud Deployment
7.33.
Polygon Calculations
7.34.
Reversible deletion of database entities
7.35.
Search Plants
7.36.
Sync
7.37.
Uuid
8.
Development Setup
❱
8.1.
Docker + local
8.2.
Devcontainer
8.3.
Reset guided tours
9.
development_setup
10.
Guidelines
❱
10.1.
REST
10.2.
Backend Logging
10.3.
Tutorial for synchronized APIs in the Map Editor
10.4.
Backend
10.5.
Code Comments
10.6.
Code Review
10.7.
Code
10.8.
Database
10.9.
Documentation
10.10.
e2e
10.11.
Files
10.12.
Frontend API Calls
10.13.
Frontend Component Responsiveness
10.14.
Creating a New Layer in Frontend
10.15.
Frontend Map Default View
10.16.
Frontend General Responsiveness
10.17.
Frontend Keybindings
10.18.
Frontend Locators
10.19.
Frontend React
10.20.
Structuring of Actions in the Store
10.21.
Using and extending the Stored Map Information in the Frontend
10.22.
Frontend UI & Usability
10.23.
Frontend
10.24.
i18n
10.25.
Manual Testing Guidelines
10.26.
Manual Testing Guidelines
10.27.
Security
10.28.
Tools Guidelines
10.29.
Upgrading to newer software releases
10.30.
Versioning
11.
Meetings
❱
11.1.
README
❱
11.1.1.
Meeting 2023-03-07
11.1.2.
Meeting 2023-03-14
11.1.3.
Meeting 2023-03-15 Gamification
11.1.4.
Meeting 2023-03-15 Polyculture Algorithm
11.1.5.
Meeting 2023-03-20 DB Kick-Off
11.1.6.
Meeting 2023-03-21
11.1.7.
Meeting 2023-03-23 Backend Kick-Off
11.1.8.
Meeting 2023-03-28
11.1.9.
Meeting 2023-03-30 - Polyculture
11.1.10.
Meeting 2023-03-31
11.1.11.
Meeting 2023-04-04
11.1.12.
Meeting 2023-04-07 DB
11.1.13.
Meeting 2023-04-07 Frontend
11.1.14.
Meeting 2023-04-11
11.1.15.
Meeting 2023-04-18
11.1.16.
Meeting 2023-04-25
11.1.17.
Meeting 2023-04-27 DB
11.1.18.
Meeting 2023-05-02
11.1.19.
Meeting 2023-05-09
11.1.20.
Meeting 2023-05-16
11.1.21.
Meeting 2023-05-23
11.1.22.
Meeting 2023-05-26 Architecture
11.1.23.
Meeting 2023-05-30
11.1.24.
Meeting 2023-06-06
11.1.25.
Meeting 2023-06-13
11.1.26.
Meeting 2023-06-20
11.1.27.
Meeting 2023-06-27
11.1.28.
Meeting 2023-07-04
11.1.29.
Meeting 2023-07-11
11.1.30.
Meeting 2023-07-18
11.1.31.
Meeting 2023-07-25
11.1.32.
Meeting 2023-07-31
11.1.33.
Meeting 2023-08-08
11.1.34.
Meeting 2023-08-15
11.1.35.
Meeting 2023-08-22
11.1.36.
Meeting 2023-08-28
11.1.37.
Meeting 2023-09-04
11.1.38.
Meeting 2023-09-11
11.1.39.
Meeting 2023-09-18
11.1.40.
Meeting 2023-09-25
11.1.41.
Meeting 2023-10-02
11.1.42.
Meeting 2023-10-09
11.1.43.
Meeting 2023-10-16
11.1.44.
Meeting 2023-10-23
11.1.45.
Meeting 2023-10-30
11.1.46.
Meeting 2023-11-06
11.1.47.
Meeting 2023-11-13
11.1.48.
Meeting 2023-11-20
11.1.49.
Meeting 2023-11-27
11.1.50.
Meeting 2023-12-04
11.1.51.
Meeting 2023-12-11
11.1.52.
Meeting 2023-12-18
11.1.53.
Meeting 2023-12-27
11.2.
README
❱
11.2.1.
Meeting 2024-01-02
11.2.2.
Meeting 2024-01-08
11.2.3.
Meeting 2024-01-15
11.2.4.
Meeting 2024-01-22
11.2.5.
Meeting 2024-01-29
11.2.6.
Meeting 2024-02-05
11.2.7.
Meeting 2024-02-12
11.2.8.
Meeting 2024-02-19
11.2.9.
Meeting 2024-03-11
11.2.10.
Meeting 25.03.2024
11.2.11.
Meeting 02.04.2024
11.2.12.
Meeting 04.04.2024 - Scrum Processes
11.2.13.
Meeting 08.04.2024
11.2.14.
Meeting 15.04.2024
11.2.15.
Meeting 22.04.2024
11.2.16.
Meeting 06.05.2024
11.2.17.
Meeting 13.05.2024
11.2.18.
Meeting 20.05.2024
11.2.19.
Meeting 27.05.2024
11.2.20.
Meeting 03.06.2024
11.2.21.
Meeting 10.06.2024
11.2.22.
Meeting 17.06.2024
11.2.23.
Meeting 24.06.2024
11.2.24.
Meeting 27.06.2024 - Heatmap
11.2.25.
Meeting 15.07.2024
11.2.26.
Meeting 22.07.2024
11.2.27.
Meeting 29.07.2024
11.2.28.
Meeting 05.08.2024
11.2.29.
Meeting 12.08.2024
11.2.30.
Meeting 19.08.2024
11.2.31.
Meeting 26.08.2024
11.2.32.
Meeting 09.09.2024
11.2.33.
Meeting 16.09.2024
11.2.34.
Meeting 23.09.2024
11.2.35.
Meeting 30.09.2024
11.2.36.
Meeting 07.10.2024
11.2.37.
Meeting 14.10.2024
11.2.38.
Meeting 21.10.2024
11.2.39.
Meeting 28.10.2024
11.2.40.
Meeting 04.11.2024
11.2.41.
Meeting 11.11.2024
11.2.42.
Meeting 23.11.2024
11.2.43.
Meeting 02.12.2024
11.2.44.
Meeting 09.12.2024
11.2.45.
Meeting 16.12.2024
11.3.
Meeting 13.1.2025
11.4.
Meeting 20.1.2025
11.5.
Meeting 27.1.2025
11.6.
Meeting 03.02.2025
11.7.
Meeting 10.02.2025
11.8.
Meeting 17.02.2025
11.9.
Meeting 24.02.2025
11.10.
Meeting 03.03.2025
11.11.
Meeting 10.03.2025
11.12.
Meeting 17.03.2025
11.13.
Meeting 24.03.2025
11.14.
Meeting 31.03.2025
11.15.
Meeting 07.04.2025
11.16.
Meeting 14.04.2025
11.17.
Meeting 21.04.2025
11.18.
Meeting 28.04.2025
11.19.
Meeting 05.05.2025
11.20.
Meeting 12.05.2025
11.21.
Meeting 19.05.2025
11.22.
Meeting 26.05.2025
11.23.
Meeting 02.06.2025
11.24.
Meeting 09.06.2025
11.25.
Meeting 16.06.2025
11.26.
Meeting 23.06.2025
11.27.
Optional Meeting 30.06.2025
11.28.
Meeting 07.07.2025
11.29.
Meeting 14.07.2025
11.30.
Biology Meeting 16.07.2025
11.31.
Meeting 21.07.2025
11.32.
Meeting 28.07.2025
11.33.
Meeting 04.08.2025
11.34.
2025_08_06_PM
11.35.
Meeting 11.08.2025
11.36.
Meeting 18.08.2025
11.37.
Meeting 25.08.2025
11.38.
Meeting 01.09.2025
11.39.
Meeting 08.09.2025
11.40.
Meeting 15.09.2025
11.41.
Meeting 22.09.2025
11.42.
Meeting 25.09.2025
11.43.
Meeting 29.09.2025
11.44.
Meeting 06.10.2025
11.45.
Meeting 13.10.2025
11.46.
Meeting 20.10.2025
11.47.
PM Meeting 24.10.2025 11:30
11.48.
Meeting 27.10.2025
11.49.
2025_10_31_PM
11.50.
Meeting 03.11.2025
11.51.
2025_11_07_PM
11.52.
Meeting 10.11.2025
11.53.
2025_11_14_PM
11.54.
Meeting 17.11.2025
11.55.
2025_11_21_PM
11.56.
Meeting 24.11.2025
11.57.
2025_11_28_PM
11.58.
Meeting 01.12.2025
11.59.
2025_12_05_PM
11.60.
Meeting 08.12.2025
11.61.
Meeting 15.12.2025
12.
Mockups
13.
Releases
❱
13.1.
0.7.0 Summer
13.2.
0.8.0
13.3.
0.9.0
13.4.
Changelog
13.5.
Releases
13.6.
Changelog
14.
Research
❱
14.1.
Keycloak Basics
14.2.
Map Performance
14.3.
Mautic Integration
14.4.
Nextcloud Integration
14.5.
Typeshare
15.
Testing Strategy
❱
15.1.
Backend Testing
15.2.
Frontend testing
15.3.
Manual Tests
❱
15.3.1.
Test Reports
❱
15.3.1.1.
README
❱
15.3.1.1.1.
Heatmap with Shade
15.3.1.1.2.
Manual Test Report (pre v0.3 case study release)
15.3.1.1.3.
Manual Test Report (v0.3 case study release)
15.3.1.1.4.
Manual Test Report (v0.3.1)
15.3.1.1.5.
Manual Test Report (v0.3.2)
15.3.1.1.6.
Manual Test Report (v0.3.3)
15.3.1.1.7.
Manual Test Report (v0.3.4)
15.3.1.1.8.
Manual Test Report (v0.3.5)
15.3.1.1.9.
Manual Test Report (v0.3.6)
15.3.1.2.
README
❱
15.3.1.2.1.
Manual Test Report (v0.4.0)
15.3.1.2.2.
Manual Test Report (v0.4.1)
15.3.1.2.3.
240801
15.3.1.2.4.
240801_dev
15.3.1.2.5.
240802_seeds
15.3.1.2.6.
241023
15.3.1.2.7.
241104
15.3.1.3.
250407
15.3.1.4.
250512
15.3.1.5.
250717
15.3.1.6.
250718
15.3.1.7.
250902
15.3.1.8.
251205
15.3.1.9.
template
15.3.2.
Test Cases
❱
15.3.2.1.
Guided Tour
15.3.2.2.
additional_layer
15.3.2.3.
Area of Plantings
15.3.2.4.
Base Layer
15.3.2.5.
Copy & Paste
15.3.2.6.
crop_rotation
15.3.2.7.
Drawing Layer
15.3.2.8.
Entry and List Seeds
15.3.2.9.
Grid
15.3.2.10.
Heatmap
15.3.2.11.
Hierarchy Test Cases
15.3.2.12.
hydrology_layer
15.3.2.13.
Inventory
15.3.2.14.
landing_page
15.3.2.15.
Layer Management
15.3.2.16.
Layer Visibility
15.3.2.17.
Login
15.3.2.18.
manage_additional_layers
15.3.2.19.
Map Creation
15.3.2.20.
Map Deletion
15.3.2.21.
Map Search
15.3.2.22.
Map Timeline
15.3.2.23.
map_timeline_event_view
15.3.2.24.
map_timeline_single_selection
15.3.2.25.
Map Toolbar
15.3.2.26.
Map Undo Redo
15.3.2.27.
Measuring Distances
15.3.2.28.
Multi Select
15.3.2.29.
Plant Layer
15.3.2.30.
Read Only
15.3.2.31.
Remembering View State of the map
15.3.2.32.
rename_layers
15.3.2.33.
Search Plants
15.3.2.34.
Shade Layer
15.3.2.35.
soil_texture_layer
15.3.2.36.
Translation
15.3.2.37.
zoom
15.4.
MODE
15.5.
Smoke Tests
❱
15.5.1.
Smoke Test Reports
❱
15.5.1.1.
Smoke Test Report
15.5.2.
Smoke Test Testcases
❱
15.5.2.1.
Smoke Test Report
15.6.
Testusers
16.
Usecases
❱
16.1.
Assigned Use Cases
❱
16.1.1.
Use Case: Map Editor Navigation Mobile Usability
16.1.2.
Use Case: Map Editor Timeline Mobile Usability
16.1.3.
Use Case: Map Editor Toolbar Mobile Usability
16.1.4.
Use Case: Nextcloud Circles
16.1.5.
Use Case: Plant attributes
16.1.6.
Use Case: Display and Manage Plant Markers
16.1.7.
Use Case: Plant search icons
16.1.8.
Use Case: Zones Layer
16.2.
Current Use Cases
❱
16.2.1.
Use Case: General Mobile Usability
16.2.2.
Use Case: Highlight Searched Plants
16.2.3.
Use Case: Map Collaboration
16.2.4.
Use Case: Remember Viewing State
16.2.5.
Use Case: Visitor chat
16.3.
Done Use Cases
❱
16.3.1.
Use Case: Access Control
16.3.2.
Use Case: Additional Layer
16.3.3.
Use Case: Area of Plantings
16.3.4.
Use Case: Base Layer
16.3.5.
Use Case: Copy & Paste Between Own Maps
16.3.6.
Use Case: Copy & Paste Between Users
16.3.7.
Use Case: Copy & Paste Via Icons
16.3.8.
Use Case: Copy & Paste Within the Same Map
16.3.9.
Use Case: Crop Rotation
16.3.10.
Use Case: Entry and List of Seeds
16.3.11.
Use Case: Grid
16.3.12.
Use Case: Guided Tour
16.3.13.
Use Case: Heatmap
16.3.14.
Use Case: Hydrology Layer
16.3.15.
Use Case: Landing Page
16.3.16.
Use Case: Layer Visibility
16.3.17.
Use Case: Login
16.3.18.
Use Case: Manage Additional Layers
16.3.19.
Use Case: Map Creation
16.3.20.
Use Case: Map Deletion
16.3.21.
Use Case: Map Search
16.3.22.
Use Case: Map Timeline Event View
16.3.23.
Use Case: Map Timeline Single Selection
16.3.24.
Use Case: Map Undo/Redo
16.3.25.
Use Case: Measuring Distance
16.3.26.
Use Case: Multi-Select
16.3.27.
Use Case: Plants Layer
16.3.28.
Use Case: Rename Layers
16.3.29.
Use Case: Search Plants
16.3.30.
Use Case: Shade Layer
16.3.31.
Use Case: Soil Layer
16.3.32.
Use Case: Translation
16.3.33.
Use Case: Zoom
16.4.
Draft Use Cases
❱
16.4.1.
Use Case: Add Plant Relationships
16.4.2.
Use Case: All Layer
16.4.3.
Use Case: Brushing
16.4.4.
Use Case: Buy Seeds
16.4.5.
Use Case: Contributing Member
16.4.6.
Use Case: Diff
16.4.7.
Use Case: Dimensioning Layer
16.4.8.
Use Case: Diversity Score
16.4.9.
Use Case: Event Notification
16.4.10.
Use Case: Experimental Results
16.4.11.
Use Case: Gain Blossoms
16.4.12.
Use Case: Habitats Layer
16.4.13.
Use Case: Import and Export Maps
16.4.14.
Use Case: Ingredient Lists
16.4.15.
Use Case: Landing Page News
16.4.16.
Use Case: Layer Alternatives
16.4.17.
Use Case: Map Honors
16.4.18.
Use Case: Map-Specific Favorite Groups
16.4.19.
Use Case: Map Statistics
16.4.20.
Use Case: Matchmaking
16.4.21.
Use Case: Membership Application
16.4.22.
Use Case: New Plant
16.4.23.
Use Case: Offline
16.4.24.
Use Case: Paths Layer
16.4.25.
Use Case: Persistent Multi Selection
16.4.26.
Use Case: Plant Database Update Notification
16.4.27.
Use Case: Plant Lore
16.4.28.
Use Case: Review Plant
16.4.29.
Use Case: Review Plant Relationships
16.4.30.
Use Case: Reward Preview
16.4.31.
Use Case: Select all plants of same type
16.4.32.
Use Case: Terrain Layer
16.4.33.
Use Case: Trees Layer
16.4.34.
Use Case: Winds Layer
16.5.
Later Use Cases
❱
16.5.1.
Use Case: Calendar
16.5.2.
Use Case: Fertilization Layer
16.5.3.
Use Case: GeoMap
16.5.4.
Use Case: Incomplete Groups
16.5.5.
Use Case: Infrastructure Layer
16.5.6.
Use Case: Landscape Layer
16.5.7.
Use Case: Map Timeline Range Selection
16.5.8.
Use Case: Map to PDF
16.5.9.
Use Case: New Member Notification
16.5.10.
Use Case: Plant List
16.5.11.
Use Case: Relation Layer
16.5.12.
Use Case: Suggest Plants
16.5.13.
Use Case: Todo Layer
16.5.14.
Use Case: Watering Layer
16.6.
Use Case: <Title (except of spaces and Title capitalization same as file name)>
17.
Workflows
❱
17.1.
Issue Creation Workflow
17.2.
Issue Triage Workflow
17.3.
Issue Refinement Workflow
17.4.
Workflow Name
17.5.
Decisions
17.6.
Iteration Planning Workflow
17.7.
Manual Testing
17.8.
Meetings Workflow
17.9.
Release Workflow
17.10.
Review Workflow
17.11.
Roles
17.12.
Tools Workflow
17.13.
Workflows
Light
Rust
Coal
Navy
Ayu
PermaplanT
Contributing to PermaplanT
This documents in this folder provide guidance for contributing to the PermaplanT project on GitLab.