Last updated Dec 24, 2022

Github Repo Structure

We have one repo for frontend, and one repo for backend. This article is going to show you what's where.

Frontend

Repo: typedreamhq/cloud

This repository contains all of our frontend code, and is separated into 2 main folders, apps and packages:

• apps: contains Next.js apps for our 4 deployments:
  • admin: for the admin dashboard, usually used for adding in templates
  • editor: for our Typedream website builder editor
  • mobile: for our Dumpl.ink link in bio builder editor
  • renderer: Hosts the rendered sites made by both Typedream & Dumplink editor
• packages: contains internal packages that are used across the apps
  • components: contains blocks in Typedream like H1, H2, Paragraph, Image, Container, etc.
    • This is mainly imported into mobile and renderer
    • The editor currently still use our old version of components that is available inside apps/editor/sharedComponents/TextEditor/components/Elements
  • core: contains core types and interfaces, including types for the elements definitions like types for H1, H2, Paragraph, etc.
  • data: contains functions to do API calls to our backend
  • dream-editor: Updated editor that is going to be used inside apps/editor, currently used in admin
  • zustand-query: A package that extends zustand to help our API calls

Backend

Repo: typedreamhq/api

This repository contains all our backend code. It's written in Go, using Echo Labstack framework to serve our APIs.