Development do’s and don’ts

Installation

Please check our README.md

Stack

• Node.js + TypeScript backend. We use our own routing engine as a replacement for Express.js or something similar. This library is documented in this guide
• Vue.js (TS) + Vite frontend
• Capacitor for the mobile app
• We use a number of custom-built libraries, mostly for frontend work or for sharing code between the frontend and backend. They’re all documented here. It might take a bit to get used to them, but once you do, you’ll see how much easier and more reusable they make our code.

Encoding & decoding

<aside> <img src="/icons/stars_yellow.svg" alt="/icons/stars_yellow.svg" width="40px" />

One of the most important concepts in our code base. Start here.

</aside>

Encoding & decoding (structures)

Writing AutoEncoder classes

Patching data

Versioning data

Frontend guides

Views and navigation (Vue App Navigation)

View building blocks (inline components and classes)

View API’s

Patching inside views

Sending (authenticated) requests in the frontend

Storing data locally in the browser/app

Backend guides

Writing endpoints

Storing data in the database

Common patterns