❗ Please be aware this is a prerelease. It does not meet production requirements yet. Want to contribute? Lets connect! ✉️ [email protected]
git clone [email protected]:cellajs/cella.git && cd cella
Create a .env in env
folder with .env.example
. Minimum requirement is DATABASE_URL
variable.
There are three ways to run Cella:
A: Directly on local machine (Recommended for active devs)
- Node: Check your Node version with
node -v
. Install Node 20.x using Volta. - pnpm: Check your pnpm version with
pnpm -v
. Install pnpm 8.x using Volta. - Postgres: Install PostgreSQL 16.x on your machine, for example using Postgres.app if you are on a Mac.
pnpm install
If starting from scratch, you will need to run a database generate + migrate.
pnpm run generate
pnpm run migrate
Check it out at http://localhost:3000:
pnpm run dev
B: From inside a VS devcontainer (Not yet stable)
- VSCode and Dev containers
- Orbstack or Docker
- Open VSCode and click one of these buttons to run the container:
- Alternatively, open the project in VSCode and use
⌘+⇧+p
to run theRemote-Containers: Reopen in Container
command.
Start command in container terminal:
pnpm run dev
- Rebuilding the docker container: Just open Orbstack and delete the container and volume that has
cella
in the name. - CORS issues: Make sure to open
http://localhost:3000/
and nothttp://127.0.0.1:3000/
C: As basic docker container (Recommended for quick start)
pnpm run docker
The users seed is required to add an ADMIN user. There is also an optional seed to add more data faker.js. In a container? Access the (backend) container to run the seeds.
pnpm run seed:users
pnpm run seed:organizations
Use Drizzle Studio to manage your local db on https://local.drizzle.studio
pnpm run studio
Cella has autogenerated API docs. View on local at https://localhost:4000/docs
- Cella uses Biome. Please install it for a correct code style. For manual lint fixing run
pnpm run check:fix
for type errorspnpm run check:types
- EADDRINUSE errors? Try
sudo lsof -i :1080 -i :3000 -i :4000
and thenkill -9 *PID*
with a space-separated list ofPID
- pnpm cache issues? Try
pnpm store prune
- turbo cache issues? Try adding
--force
to the command - docker cache issues? Try
docker builder prune --force
💙💛 Built on top of amazing OS projects! Mainly drizzle-orm, honojs, tanstack-router & shadcn.