1.5 KiB
1.5 KiB
Contributing
"First, thanks for considering to contribute to my project. It really means a lot!" - @andrasbacsai
You can ask for guidance anytime on our
Discord server in the #contribution channel.
Code Contribution
1) Setup your development environment
- You need to have Docker Engine (or equivalent) installed on your system.
- For better DX, install Spin.
2) Set your environment variables
- Copy .env.development.example to .env.
3) Start & setup Coolify
- 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 upinstead.
- If you see weird permission errors, especially on Mac, run
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.
4) Start development
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.
Mails are caught by Mailpit: localhost:8025
New Service Contribution
Check out the docs here.