CodePod: coding on a canvas, organized.

Developing CodePod using docker-compose

The docker compose files are in compose/dev folder. The dev stack mounts the src folder, so that you can edit the files on your local computer, and let the node.js process inside the container do the compiling and hot-reloading.

To install docker-compose, follow this official instruction.

First, create a dev/.env file with the following content (leave as is or change the value to whatever you want). You probably don't need the GOOGLE_CLIENT_ID is you don't need Google's OAuth.

POSTGRES_USER=myusername
POSTGRES_PASSWORD=mypassword
POSTGRES_DB=mydbname
JWT_SECRET=mysupersecretjwttoken
GOOGLE_CLIENT_ID=<google oauth client id>

Start the stack:

cd dev
docker compose up -d

You need to initialized the database if this is the first time to start the stack. See below.

Wait a few minutes for packages installation and compilation. Once ui and api containers are ready listening on http ports, go to http://localhost:80 to see the app.

• http://localhost:80/graphql: Apollo GraphQL explorer for the backend APIs
• http://prisma.127.0.0.1.sslip.io: Prisma Studio for viewing and debugging the database.

Initialize the database

If this is your first time running it, the database is empty, and you need to initialize the database. To do that, open a shell into the API container and run:

npx prisma migrate dev

This command is also needed after the database schema is changed.

Contributing

CodePod is open source under MIT license. Feel free to contribute! We can make it better together. You can contribute by opening an issue, discussion, or submit a pull request. Please use Prettier (e.g., its VSCode plugin) to format your code before checking in.