From 07aa285b279696f5bd4d886b2c6d5fcc38e4783c Mon Sep 17 00:00:00 2001 From: Andras Bacsai Date: Sat, 16 Apr 2022 22:31:30 +0200 Subject: [PATCH] updates on docs --- CONTRIBUTING.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0b9aaf7bd..4122aab7d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ First of all, thank you for considering contributing to my project! It means a l - Node.js / Javascript - Svelte / SvelteKit -- Prisma.io +- Prisma.io / SQL # Recommended Pull Request Guideline @@ -18,6 +18,8 @@ First of all, thank you for considering contributing to my project! It means a l - Write a proper description - Open the pull request to review +--- + # How to start after you set up your local fork? Due to the lock file, this repository is best with [pnpm](https://pnpm.io). I recommend you try and use `pnpm` because it is cool and efficient! @@ -45,7 +47,7 @@ If the schema is finalized, you need to create a migration file with `pnpm db:mi --- -# Adding new services +# How to add new services You can add any open-source and self-hostable software (service/application) to Coolify if the following statements are true: @@ -90,7 +92,7 @@ You need to add a new folder to [src/routes/services/[id]](src/routes/services/[ - You need to define a compose file as `const composeFile: ComposeFile` found in [src/routes/services/[id]/minio/start.json.ts](src/routes/services/[id]/minio/start.json.ts) - IMPORTANT: It should contain `all the default environment variables` that are required for the service to function correctly and `all the volumes to persist data` in restarts. + **IMPORTANT:** It should contain `all the default environment variables` that are required for the service to function correctly and `all the volumes to persist data` in restarts. - You could also define an `HTTP` or `TCP` proxy for every other port that should be proxied to your server. (See `startHttpProxy` and `startTcpProxy` functions)