cupcakearmy/coolify
1
0
Fork 0
mirror of https://github.com/cupcakearmy/coolify.git synced 2024-10-22 16:14:22 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

update contribution guide

Browse Source
This commit is contained in:
Andras Bacsai 2023-10-19 10:50:47 +02:00
parent cfc4d3acc7
commit 166419b13a
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTION.md
View File

@ -6,13 +6,14 @@ # Contributing
You can ask for guidance anytime on our You can ask for guidance anytime on our
[Discord server](https://coollabs.io/discord) in the `#contribution` channel. [Discord server](https://coollabs.io/discord) in the `#contribution` channel.
## Code Contribution
## 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/). - For better DX, install [Spin](https://serversideup.net/open-source/spin/).
## 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.
@ -23,9 +24,14 @@ ## 3) Start & setup Coolify
- Run `./scripts/run setup:dev` - This will generate a secret key for you, delete any existing database layouts, migrate database to the new layout, and seed your database. - Run `./scripts/run setup:dev` - This will generate a secret key for you, delete any existing database layouts, migrate database to the new layout, and seed your database.
## 4) Start development ### 4) 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
Check out the docs [here](https://coolify.io/docs/how-to-add-a-service).