Skip to content

Commit c566690

Browse files
committed
docs: add continuous development
1 parent 2fb2fde commit c566690

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,18 @@ make gen-prisma-schema
6262
```
6363
This generates both SQLite and PostgreSQL schemas and TypeScript definitions.
6464

65-
3. Create and apply migrations:
65+
3. Create migrations file:
6666
```bash
6767
make db-migration
6868
```
6969

70+
4. Apply migrations:
71+
```bash
72+
make switch-db-mode
73+
```
74+
7075
> **Note**
71-
> If you need to modify the schema after migration, delete the generated migration files and database records, then start over from step 1.
76+
> If you need to modify the schema after applying migrations, you need to delete the latest migration file and run `pnpm prisma-migrate-reset` in `packages/db-main-prisma` to reset the database. (Make sure you run it in the development database.)
7277
7378
## Testing
7479

@@ -138,6 +143,8 @@ We have two main Docker images:
138143
- `teable-db-migrate`: Database migration tool (one-time setup tool)
139144

140145
#### Build the Application Image
146+
> **Note**
147+
> You should run this command in the root directory.
141148
142149
```bash
143150
# Build the main application image
@@ -162,13 +169,12 @@ docker build -f dockers/teable/Dockerfile.db-migrate -t teable-db-migrate:latest
162169
```bash
163170
# Tag your local image
164171
docker tag teable:latest your-username/teable:latest
172+
docker tag teable-db-migrate:latest your-username/teable-db-migrate:latest
165173

166174
# Login to Docker Hub
167175
docker login
168176

169177
# Push the image
170178
docker push your-username/teable:latest
179+
docker push your-username/teable-db-migrate:latest
171180
```
172-
173-
> **Note**
174-
> For production builds, we use GitHub Actions to automatically build and push multi-architecture images to our container registries.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,10 @@ cd apps/nestjs-backend
204204
pnpm dev
205205
```
206206

207+
### Contribution
208+
209+
For detailed contribution guidelines, please see our [CONTRIBUTING.md](./CONTRIBUTING.md) file.
210+
207211
## Why Teable?
208212

209213
No-code tools have significantly speed up how we get things done, allowing non-tech users to build amazing apps and changing the way many work and live. People like using spreadsheet-like UI to handle their data because it's easy, flexible, and great for team collaboration. They also prefer designing their app screens without being stuck with clunky templates.

0 commit comments

Comments
 (0)