Skip to content

Commit 635929b

Browse files
committed
add docs
1 parent d5e854a commit 635929b

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

DEPLOYMENT.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Deployment & CI
2+
3+
TypeCell currently consists of
4+
5+
| | development / CI | staging | prod |
6+
| ----------------------------------- | ---------------- | --------------------------- | ------------------------ |
7+
| React app (packages/editor) | Local | Vercel (branch-specific) | Vercel |
8+
| HocusPocus Server (packages/server) | Local | Render (typecell-staging) | Render (typecell-prod) |
9+
| Supabase DB infra (packages/server) | Docker | Supabase (typecell-staging) | Supabase (typecell-prod) |
10+
11+
A few principles:
12+
13+
- All Github Actions run against `local` (i.e.: no external dependencies)
14+
- All components should be easy to self-host, we don't want forced dependencies on any cloud provider (note that both supabase and the server are self-hostable).
15+
- Only www.typecell.org is considered `prod`. All Vercel branch-preview environments are considered `staging`, except the main branch which is `prod`.
16+
- Preview environments all share the same `staging` database. This means feature-branches must be compatible in terms of database schema.
17+
- DB Migrations are deployed to `staging` / `prod` when they are pushed to the `staging` / `main` branch (see github workflows).
18+
19+
## Self-host
20+
21+
It should be fairly straightforward to host TypeCell yourself, at this moment we don't have a guide for this yet.

0 commit comments

Comments
 (0)