2023-10-02 12:58:29 +00:00
|
|
|
# Contributing
|
|
|
|
|
|
|
|
|
|
> "First, thanks for considering to contribute to my project.
|
|
|
|
|
It really means a lot!" - [@andrasbacsai](https://github.com/andrasbacsai)
|
|
|
|
|
|
|
|
|
|
You can ask for guidance anytime on our
|
|
|
|
|
[Discord server](https://coollabs.io/discord) in the `#contribution` channel.
|
|
|
|
|
|
2023-10-19 08:50:47 +00:00
|
|
|
## Code Contribution
|
2023-10-02 12:58:29 +00:00
|
|
|
|
2023-10-19 08:50:47 +00:00
|
|
|
### 1) Setup your development environment
|
2023-10-02 12:58:29 +00:00
|
|
|
|
|
|
|
|
- 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/).
|
|
|
|
|
|
2023-10-19 08:50:47 +00:00
|
|
|
### 2) Set your environment variables
|
2023-10-02 12:58:29 +00:00
|
|
|
|
|
|
|
|
- Copy [.env.development.example](./.env.development.example) to .env.
|
|
|
|
|
|
|
|
|
|
## 3) Start & setup Coolify
|
|
|
|
|
|
|
|
|
|
- Run `spin up` - You can notice that errors will be thrown. Don't worry.
|
2023-10-06 18:45:35 +00:00
|
|
|
- If you see weird permission errors, especially on Mac, run `sudo spin up` instead.
|
|
|
|
|
|
2023-12-13 10:12:53 +00:00
|
|
|
If you are running Coolify for the first time:
|
|
|
|
|
- Run `./scripts/run dev:init` - This will delete any existing database layouts, migrate database to the new layout, and seed your database.
|
|
|
|
|
|
|
|
|
|
> If you see the login page with a 404 error, you forgot to run `./scripts/run dev:init`.
|
2023-10-02 12:58:29 +00:00
|
|
|
|
2023-10-19 08:50:47 +00:00
|
|
|
### 4) Start development
|
2023-10-02 12:58:29 +00:00
|
|
|
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.
|
2023-10-17 18:54:26 +00:00
|
|
|
|
|
|
|
|
Mails are caught by Mailpit: `localhost:8025`
|
2023-10-19 08:50:47 +00:00
|
|
|
|
|
|
|
|
## New Service Contribution
|
|
|
|
|
Check out the docs [here](https://coolify.io/docs/how-to-add-a-service).
|
|
|
|
|
|
