coolify/CONTRIBUTION.md

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.

You'll need a set of skills to get started.

1) Setup your development environment

• 🌟 Container based ← Recommended
• 📦 DockerContainer *WIP
• 🐙 Github Codespaces
• ☁️ GitPod
• 🍏 Local Mac

2) Basic requirements

• Install Pnpm
• Install Docker Engine
• Setup Docker Compose Plugin
• Setup GIT LFS Support

3) Setup Coolify

• Copy apps/api/.env.example to apps/api/.env
• Edit apps/api/.env, set the COOLIFY_APP_ID environment variable to something cool.
• Run pnpm install to install dependencies.
• Run pnpm db:push to create a local SQlite database. This will apply all migrations at db/dev.db.
• Run pnpm db:seed seed the database.
• Run pnpm dev start coding.

# Or... Copy and paste commands below:
cp apps/api/.env.example apps/api/.env
pnpm install
pnpm db:push
pnpm db:seed
pnpm dev

4) Start Coding

You should be able to access http://localhost:3000.

1. Click Register and setup your first user.