Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 1.6 KB

QUICKSTART.md

File metadata and controls

46 lines (34 loc) · 1.6 KB

Quickstart

This document describes how to develop your own app based on Cella.

Also read the architecture info.

Run with pglite

pnpm install
pnpm quick

Run it with full postgres and electric-sync in docker

pnpm install
pnpm docker
pnpm dev
pnpm seed

Customize & contribute

  1. Customize your config in /config/default.ts
  2. Update package.json with your own data
  3. Look at your .env file to understand what is required, for example to send emails you will need an API key.
  4. Explore readmes and config files with filenames like -config.ts. For example for entities or navigation structure.
  5. Cella currently uses its homegrown imado service for file handling. It combines TUS. AWS Lambda, S3 and Cloudfront. However, you can also use local file storage during development. This gives you time to explore how to approach file handling for your app.
  6. Many things can be improved or are missing. Have a look at our roadmap and contact us to get involved.

Cella CLI

Cella CLI is currently limited to: creating a cella project, listing diverged files and pulling upstream changes. Config can be found in cella.config.js.

List diverged

Receive a list of files that have diverged from cella itself. The files you have ignored in cella.config.js will not be listed.

pnpm diverged

Pull upstream

Pull upstream changes from cella. Changes in files that are in the cella ignore list will automatically be undone to reduce conflicts.

pnpm upstream:pull