|
1 | 1 | # CodePod: coding on a canvas, organized. |
2 | 2 |
|
3 | | - |
| 3 | +Codepod provides the interactive coding experience popularized by Jupyter, but |
| 4 | +with scalability and production-readiness. Users can still incrementally build |
| 5 | +up code by trying out a small code snippet each time. But they would not be |
| 6 | +overwhelmed by the great number of code snippets as the projects grow. |
| 7 | + |
| 8 | + |
4 | 9 |
|
5 | 10 | # We are on Beta testing |
6 | 11 |
|
7 | | -And we are actively polishing everything. You might want to take a look at the [known issues](https://github.com/codepod-io/codepod/wiki/Known-Issues) along your adventure with Codepod. |
| 12 | +And we are actively polishing everything. You might want to take a look at the |
| 13 | +[known |
| 14 | +issues](<https://github.com/codepod-io/codepod/wiki/Known-Issues-(and-we-are-fixing-them!)>) |
| 15 | +along your adventure with Codepod. |
| 16 | + |
| 17 | +# Contributing |
| 18 | + |
| 19 | +CodePod is open source under MIT license. Feel free to contribute! We can make |
| 20 | +it better together. You can contribute by opening an issue, discussion, or |
| 21 | +submit a pull request. Please use [Prettier](https://prettier.io/) (e.g., [its |
| 22 | +VSCode |
| 23 | +plugin](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)) |
| 24 | +to format your code before checking in. |
8 | 25 |
|
9 | 26 | # Developing CodePod using docker-compose |
10 | 27 |
|
@@ -50,13 +67,18 @@ initialize the database. To do that, open a shell into the API container and run |
50 | 67 | npx prisma migrate dev |
51 | 68 | ``` |
52 | 69 |
|
53 | | -This command is also needed after the database schema is changed. |
| 70 | +This command is also needed after the database schema is changed. The protocol is: |
54 | 71 |
|
55 | | -# Contributing |
| 72 | +- One developer changed [the schema](./api/prisma/schema.prisma). He will run |
| 73 | + `npx prisma migrate dev --name add_a_new_field`. This will generate a |
| 74 | + migration, e.g. [this |
| 75 | + migration](./api/prisma/migrations/20221206194247_add_google_login/migration.sql). |
| 76 | + The schema change along with this migration need to be checked in to git. |
| 77 | +- Another developer pull the change, then run `npx prisma migrate dev` (in the |
| 78 | + api container's shell) to apply the schema change. |
56 | 79 |
|
57 | | -CodePod is open source under MIT license. Feel free to contribute! We can make |
58 | | -it better together. You can contribute by opening an issue, discussion, or |
59 | | -submit a pull request. Please use [Prettier](https://prettier.io/) (e.g., [its |
60 | | -VSCode |
61 | | -plugin](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)) |
62 | | -to format your code before checking in. |
| 80 | +## Auto-completion & Linting |
| 81 | + |
| 82 | +Although we develop using docker, we still want auto-complete and linting while |
| 83 | +coding. For that to work, you need to install the node packages locally, i.e., |
| 84 | +run `yarn` in `api/`, `ui/`, etc. |
0 commit comments