https://github.com/cellajs/cella
Template to build web apps with sync engine using hono, pg, drizzle, electric-sync, react, shadcn.
https://github.com/cellajs/cella
drizzle hono openapi postgres react react-query shadcn tanstack-router vite zod zustand
Last synced: about 1 month ago
JSON representation
Template to build web apps with sync engine using hono, pg, drizzle, electric-sync, react, shadcn.
- Host: GitHub
- URL: https://github.com/cellajs/cella
- Owner: cellajs
- License: mit
- Created: 2023-12-19T21:18:46.000Z (over 1 year ago)
- Default Branch: development
- Last Pushed: 2025-04-04T14:43:11.000Z (about 1 month ago)
- Last Synced: 2025-04-05T00:35:41.623Z (about 1 month ago)
- Topics: drizzle, hono, openapi, postgres, react, react-query, shadcn, tanstack-router, vite, zod, zustand
- Language: TypeScript
- Homepage: https://cellajs.com
- Size: 19.6 MB
- Stars: 358
- Watchers: 2
- Forks: 35
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
Cella
Single stack TypeScript template to build web apps with sync & offline capabilities.
Website
·
Prerelease
·
MIT license
> [!CAUTION]
> This is a prerelease. It does NOT meet production requirements yet and large breaking changes occur regularly. Versioned releases will begin once we have solid tests for authentication, authorization and data access. Want to contribute or discuss cella with us? Let's connect! ✉️
#### Contents
- [Installation](#installation)
- [Architecture](/info/ARCHITECTURE.md)
- [Roadmap](/info/ROADMAP.md)
- [Deployment](/info/DEPLOYMENT.md)
## Requirements
- Make sure you have node installed with `node -v`. Install Node 20.x or 22.x. (ie. [Volta](https://docs.volta.sh/guide/)).
- Ideally you work with [git over ssh](https://docs.github.com/en/authentication/connecting-to-github-with-ssh).
## Create your own app
Want to try cella to build your new web app? We made it simple with a create CLI. Simply follow the steps to get started:
```bash
pnpm create @cellajs/cella@latest
```
You now have an implementation-ready web app 🤯. But ... without any unique functionality 🤓. Read the [Quickstart](/info/QUICKSTART.md) so you can build something unique quickly.
## Installation
For those that (also) want to participate in development:
```bash
git clone [email protected]:cellajs/cella.git && cd cella
```
### A. Quick setup
Run your db using a local pglite. Its fast to build and to clean up. Simply remove `backend/.db`. However, you need to use the full setup to run electric-sync.
```bash
pnpm install && pnpm quick
```
### B. Full setup
For a full setup with sync capabilities, you need Docker. It will allow you to run Postgres + electric-sync. Install [Orbstack](https://orbstack.dev/) or [Docker](https://docs.docker.com/get-docker/).
```bash
pnpm install
pnpm docker
```
Start all servers:
```bash
pnpm dev
```
Lastly, [seed](/backend/scripts/README.md) your db (with `dev` running) to sign in as [admin user](/backend/scripts/README.md).
```bash
pnpm seed
```
Check it out at [localhost:3000](http://localhost:3000)! Generated API docs can be found at [localhost:4000/docs](http://localhost:4000/docs). Manage your local db with [local.drizzle.studio](http:local.drizzle.studio).
💙💛 Big thank you to [drizzle](https://github.com/drizzle-team/drizzle-orm), [hono](https://github.com/honojs/hono), [tanstack-router](https://github.com/tanstack/router) & [electric](https://github.com/electric-sql/electric).