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

change heading levels

Browse Source
This commit is contained in:
ayntk-ai
2024-08-26 15:44:30 +02:00
parent 8d24e93a16
commit 3c413ff5c9
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
CONTRIBUTING.md
View File

@@ -7,11 +7,11 @@ You can ask for guidance anytime on our [Discord server](https://coollabs.io/dis
## Code Contribution ## Code Contribution
### 1. Setup your development environment ## 1. Setup your development environment
Follow the steps below for your operating system: Follow the steps below for your operating system:
#### Windows ### Windows
1. Install Docker Desktop (or similar): 1. Install Docker Desktop (or similar):
- Download and install [Docker Desktop for Windows](https://docs.docker.com/desktop/install/windows-install/) - Download and install [Docker Desktop for Windows](https://docs.docker.com/desktop/install/windows-install/)
@@ -20,7 +20,7 @@ Follow the steps below for your operating system:
2. Install Spin: 2. Install Spin:
- Follow the instructions to install Spin on Windows from the [Spin documentation](https://serversideup.net/open-source/spin/docs/installation/install-windows) - Follow the instructions to install Spin on Windows from the [Spin documentation](https://serversideup.net/open-source/spin/docs/installation/install-windows)
#### MacOS ### MacOS
1. Install Orbstack or Docker Desktop (or similar): 1. Install Orbstack or Docker Desktop (or similar):
- Orbstack (faster, lighter, better alternative to Docker Desktop) - Orbstack (faster, lighter, better alternative to Docker Desktop)
@@ -31,7 +31,7 @@ Follow the steps below for your operating system:
2. Install Spin: 2. Install Spin:
- Follow the instructions to install Spin on MacOS from the [Spin documentation](https://serversideup.net/open-source/spin/docs/installation/install-macos) - Follow the instructions to install Spin on MacOS from the [Spin documentation](https://serversideup.net/open-source/spin/docs/installation/install-macos)
#### Linux ### Linux
1. Install Docker Engine or Docker Desktop (or similar): 1. Install Docker Engine or Docker Desktop (or similar):
- Docker Engine (recommended): - Docker Engine (recommended):
@@ -44,7 +44,7 @@ Follow the steps below for your operating system:
--- ---
### 2. Verify Installation ## 2. Verify Installation
After installing Docker (or Orbstack) and Spin, verify the installation: After installing Docker (or Orbstack) and Spin, verify the installation:
@@ -58,20 +58,20 @@ After installing Docker (or Orbstack) and Spin, verify the installation:
--- ---
### 3. Fork/Clone the Coolify Repository and Setup your Development Environment ## 3. Fork/Clone the Coolify Repository and Setup your Development Environment
1. Fork/clone the [Coolify](https://github.com/coollabsio/coolify) repository to your GitHub account. 1. Fork/clone the [Coolify](https://github.com/coollabsio/coolify) repository to your GitHub account.
2. Install a code editor on your machine (choose one): 2. Install a code editor on your machine (choose one):
- Visual Studio Code: - Visual Studio Code:
- Windows/macOS/Linux: Download and install from [https://code.visualstudio.com/](https://code.visualstudio.com/) - Windows/macOS/Linux: Download and install from [https://code.visualstudio.com/download](https://code.visualstudio.com/download)
- Cursor (recommended): - Cursor (recommended):
- Windows/macOS/Linux: Download and install from [https://cursor.sh/](https://cursor.sh/) - Windows/macOS/Linux: Download and install from [https://cursor.sh/](https://cursor.sh/)
- Zed (very fast code editor): - Zed (very fast code editor):
- macOS/Linux: Download and install from [https://zed.dev/](https://zed.dev/) - macOS/Linux: Download and install from [https://zed.dev/download](https://zed.dev/download)
- Windows: Not available yet - Windows: Not available yet
3. Clone the Coolify Repository to your local machine 3. Clone the Coolify Repository to your local machine
@@ -83,7 +83,7 @@ After installing Docker (or Orbstack) and Spin, verify the installation:
--- ---
### 4. Set up Environment Variables ## 4. Set up Environment Variables
1. Copy the `.env.development.example` file to your `.env` file. 1. Copy the `.env.development.example` file to your `.env` file.
@@ -98,7 +98,7 @@ After installing Docker (or Orbstack) and Spin, verify the installation:
--- ---
### 5. Start & Setup Coolify ## 5. Start & Setup Coolify
1. Open a terminal in the Coolify directory. 1. Open a terminal in the Coolify directory.
@@ -115,7 +115,7 @@ After installing Docker (or Orbstack) and Spin, verify the installation:
--- ---
### 6. Start Development ## 6. Start Development
1. Access your Coolify instance: 1. Access your Coolify instance:
- URL: `http://localhost:8000` - URL: `http://localhost:8000`
@@ -134,7 +134,7 @@ After installing Docker (or Orbstack) and Spin, verify the installation:
--- ---
### 7. Contributing a New Service ## 7. Contributing a New Service
To add a new service to Coolify, please refer to our documentation: To add a new service to Coolify, please refer to our documentation:
[Adding a New Service](https://coolify.io/docs/knowledge-base/add-a-service) [Adding a New Service](https://coolify.io/docs/knowledge-base/add-a-service)