dave/coolify
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

updated contributing docs

Browse Source
This commit is contained in:
ayntk-ai
2024-08-07 21:11:23 +02:00
parent bacd2531b5
commit bfd79c5270
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTION.md
View File

@@ -11,24 +11,29 @@ You can ask for guidance anytime on our
### 1) Setup your development environment ### 1) Setup your development environment
- You need to have Docker Engine (or equivalent) [installed](https://docs.docker.com/engine/install/) on your system. - You need to have Docker Engine (or equivalent) [installed](https://docs.docker.com/engine/install/) on your system.
- For better DX, install [Spin](https://serversideup.net/open-source/spin/). - If you are using a Mac, I highly recommend installing [Orbsatck](https://orbstack.dev/download) as a much faster alternative and complete replacement to Docker Desktop.
- For better DX, install [Spin](https://serversideup.net/open-source/spin/docs).
### 2) Set your environment variables ### 2) Set your environment variables
- Copy [.env.development.example](./.env.development.example) to .env. - Copy [.env.development.example](./.env.development.example) to .env.
- Make sure to set the DB_HOST environment variable to the Postgres container IP or, if using Orbstack, use the container name (e.g., postgres.coolify.orb.local) to make sure that the DB Migrations work.
## 3) Start & setup Coolify ## 3) Start & setup Coolify
- Run `spin up` - You can notice that errors will be thrown. Don't worry. - Run `spin up` - You can notice that errors will be thrown. Don't worry.
- If you see weird permission errors, especially on Mac, run `sudo spin up` instead. - If you see weird permission errors, especially on Mac, run `sudo spin up` instead.
### 4) Start development ## 4) Install php to make sure you can do DB migrations (optional)
### 5) Start development
You can login your Coolify instance at `localhost:8000` with `test@example.com` and `password`. You can login your Coolify instance at `localhost:8000` with `test@example.com` and `password`.
Your horizon (Laravel scheduler): `localhost:8000/horizon` - Only reachable if you logged in with root user. Your horizon (Laravel scheduler): `localhost:8000/horizon` - Only reachable if you logged in with root user.
Mails are caught by Mailpit: `localhost:8025` Mails are caught by Mailpit: `localhost:8025`
## New Service Contribution ## New Service Contribution
Check out the docs [here](https://coolify.io/docs/knowledge-base/add-a-service). Check out the docs [here](https://coolify.io/docs/knowledge-base/add-a-service).