Developer Documentation

Welcome to the developer documentation page. Here you can find technical information about developing our products and services.

Introduction Who the developer documentation is for and the tools you need to contribute

Getting Started A guide to get you set-up contributing code to the Graasp platform

Node Package Managers Installing node package managers

Troubleshooting Common issues when setting up the development environment and their workarounds

Mobile Development Set up the unmaintained Graasp mobile app for local development

apps

Introduction to Graasp Apps

General concepts

Permissions model for apps

Local development

Communication with other components

Deployment of apps Documentation under construction

architecture

Architecture High level description of the architecture of Graasp

Frontend Architecture of the Graasp frontend applications

Backend Architecture of the Graasp backend services

DevOps How Graasp is operated and deployed

etiquette

Style Guide Our rules for a uniform style accross repositories

guides

Feature Analysis Helps refine the feature before implementation

Offloading task to worker How to move heavy processing tasks to a worker

Should we implement this?

how-to

Migrate to Eslint v9 Migrate a React Typescript project to eslint v9 flat configs

Deploy a new backend version This descibes the process of deploying a new core version of the application

references

Deployment How the Graasp platform is packaged and deployed

Release Please How we use release-please and how to fix a failed release

Queues and Workers Background jobs offloaded to queues and workers

Did not find what you were looking for? Contact us