Skip to content

Commit ac60b8c

Browse files
committed
chore: Remove unused .env.development.example file
1 parent 46ae2a4 commit ac60b8c

File tree

2 files changed

+74
-72
lines changed

2 files changed

+74
-72
lines changed

CONTRIBUTING.md

Lines changed: 74 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@ You can ask for guidance anytime on our [Discord server](https://coollabs.io/dis
1414
- [4. Set up Environment Variables](#4-set-up-environment-variables)
1515
- [5. Start Coolify](#5-start-coolify)
1616
- [6. Start Development](#6-start-development)
17-
- [7. Development Notes](#7-development-notes)
18-
- [8. Create a Pull Request](#8-create-a-pull-request)
17+
- [7. Create a Pull Request](#7-create-a-pull-request)
18+
- [Development Notes](#development-notes)
19+
- [Resetting Development Environment](#resetting-development-environment)
1920
- [Additional Contribution Guidelines](#additional-contribution-guidelines)
2021
- [Contributing a New Service](#contributing-a-new-service)
2122
- [Contributing to Documentation](#contributing-to-documentation)
@@ -29,15 +30,15 @@ Follow the steps below for your operating system:
2930

3031
1. Install `docker-ce`, Docker Desktop (or similar):
3132
- Docker CE (recommended):
32-
- Install Windows Subsystem for Linux v2 (WSL2) by following this guide: [Install WSL](https://learn.microsoft.com/en-us/windows/wsl/install)
33-
- After installing WSL2, install Docker CE for your Linux distribution by following this guide: [Install Docker Engine](https://docs.docker.com/engine/install/)
33+
- Install Windows Subsystem for Linux v2 (WSL2) by following this guide: [Install WSL](https://learn.microsoft.com/en-us/windows/wsl/install?ref=coolify)
34+
- After installing WSL2, install Docker CE for your Linux distribution by following this guide: [Install Docker Engine](https://docs.docker.com/engine/install/?ref=coolify)
3435
- Make sure to choose the appropriate Linux distribution (e.g., Ubuntu) when following the Docker installation guide
3536
- Install Docker Desktop (easier):
36-
- Download and install [Docker Desktop for Windows](https://docs.docker.com/desktop/install/windows-install/)
37+
- Download and install [Docker Desktop for Windows](https://docs.docker.com/desktop/install/windows-install/?ref=coolify)
3738
- Ensure WSL2 backend is enabled in Docker Desktop settings
3839

3940
2. Install Spin:
40-
- Follow the instructions to install Spin on Windows from the [Spin documentation](https://serversideup.net/open-source/spin/docs/installation/install-windows#download-and-install-spin-into-wsl2)
41+
- Follow the instructions to install Spin on Windows from the [Spin documentation](https://serversideup.net/open-source/spin/docs/installation/install-windows#download-and-install-spin-into-wsl2?ref=coolify)
4142

4243
</details>
4344

@@ -46,12 +47,12 @@ Follow the steps below for your operating system:
4647

4748
1. Install Orbstack, Docker Desktop (or similar):
4849
- Orbstack (recommended, as it is a faster and lighter alternative to Docker Desktop):
49-
- Download and install [Orbstack](https://docs.orbstack.dev/quick-start#installation)
50+
- Download and install [Orbstack](https://docs.orbstack.dev/quick-start#installation?ref=coolify)
5051
- Docker Desktop:
51-
- Download and install [Docker Desktop for Mac](https://docs.docker.com/desktop/install/mac-install/)
52+
- Download and install [Docker Desktop for Mac](https://docs.docker.com/desktop/install/mac-install/?ref=coolify)
5253

5354
2. Install Spin:
54-
- Follow the instructions to install Spin on MacOS from the [Spin documentation](https://serversideup.net/open-source/spin/docs/installation/install-macos/#download-and-install-spin)
55+
- Follow the instructions to install Spin on MacOS from the [Spin documentation](https://serversideup.net/open-source/spin/docs/installation/install-macos/#download-and-install-spin?ref=coolify)
5556

5657
</details>
5758

@@ -60,12 +61,12 @@ Follow the steps below for your operating system:
6061

6162
1. Install Docker Engine, Docker Desktop (or similar):
6263
- Docker Engine (recommended, as there is no VM overhead):
63-
- Follow the official [Docker Engine installation guide](https://docs.docker.com/engine/install/) for your Linux distribution
64+
- Follow the official [Docker Engine installation guide](https://docs.docker.com/engine/install/?ref=coolify) for your Linux distribution
6465
- Docker Desktop:
65-
- If you want a GUI, you can use [Docker Desktop for Linux](https://docs.docker.com/desktop/install/linux-install/)
66+
- If you want a GUI, you can use [Docker Desktop for Linux](https://docs.docker.com/desktop/install/linux-install/?ref=coolify)
6667

6768
2. Install Spin:
68-
- Follow the instructions to install Spin on Linux from the [Spin documentation](https://serversideup.net/open-source/spin/docs/installation/install-linux#configure-docker-permissions)
69+
- Follow the instructions to install Spin on Linux from the [Spin documentation](https://serversideup.net/open-source/spin/docs/installation/install-linux#configure-docker-permissions?ref=coolify)
6970

7071
</details>
7172

@@ -89,14 +90,14 @@ After installing Docker (or Orbstack) and Spin, verify the installation:
8990

9091
| Editor | Platform | Download Link |
9192
|--------|----------|---------------|
92-
| Visual Studio Code (recommended free) | Windows/macOS/Linux | [Download](https://code.visualstudio.com/download) |
93-
| Cursor (recommended but paid) | Windows/macOS/Linux | [Download](https://www.cursor.com/) |
94-
| Zed (very fast) | macOS/Linux | [Download](https://zed.dev/download) |
93+
| Visual Studio Code (recommended free) | Windows/macOS/Linux | [Download](https://code.visualstudio.com/download?ref=coolify) |
94+
| Cursor (recommended but paid) | Windows/macOS/Linux | [Download](https://www.cursor.com/?ref=coolify) |
95+
| Zed (very fast) | macOS/Linux | [Download](https://zed.dev/download?ref=coolify) |
9596

9697
3. Clone the Coolify Repository from your fork to your local machine
9798
- Use `git clone` in the command line, or
9899
- Use GitHub Desktop (recommended):
99-
- Download and install from [https://desktop.github.com/](https://desktop.github.com/)
100+
- Download and install from [https://desktop.github.com/](https://desktop.github.com/?ref=coolify)
100101
- Open GitHub Desktop and login with your GitHub account
101102
- Click on `File` -> `Clone Repository` select `github.com` as the repository location, then select your forked Coolify repository, choose the local path and then click `Clone`
102103

@@ -149,26 +150,7 @@ After installing Docker (or Orbstack) and Spin, verify the installation:
149150
> TELESCOPE_ENABLED=true
150151
> ```
151152
152-
## 7. Development Notes
153-
154-
When working on Coolify, keep the following in mind:
155-
156-
1. **Database Migrations**: After switching branches or making changes to the database structure, always run migrations:
157-
```bash
158-
docker exec -it coolify php artisan migrate
159-
```
160-
161-
2. **Resetting Development Setup**: To reset your development setup to a clean database with default values:
162-
```bash
163-
docker exec -it coolify php artisan migrate:fresh --seed
164-
```
165-
166-
3. **Troubleshooting**: If you encounter unexpected behavior, ensure your database is up-to-date with the latest migrations and if possible reset the development setup to eliminate any environment-specific issues.
167-
168-
> [!IMPORTANT]
169-
> Forgetting to migrate the database can cause problems, so make it a habit to run migrations after pulling changes or switching branches.
170-
171-
## 8. Create a Pull Request
153+
## 7. Create a Pull Request
172154
173155
1. After making changes or adding a new service:
174156
- Commit your changes to your forked repository.
@@ -183,8 +165,7 @@ When working on Coolify, keep the following in mind:
183165
184166
3. Filling out the PR details:
185167
- Give your PR a descriptive title.
186-
- In the description, explain the changes you've made.
187-
- Reference any related issues by using keywords like "Fixes #123" or "Closes #456".
168+
- Use the Pull Request Template provided and fill in the details.
188169
189170
> [!IMPORTANT]
190171
> Always set the base branch for your PR to the `next` branch of the Coolify repository, not the `main` branch.
@@ -198,6 +179,61 @@ When working on Coolify, keep the following in mind:
198179
199180
After submission, maintainers will review your PR and may request changes or provide feedback.
200181
182+
## Development Notes
183+
184+
When working on Coolify, keep the following in mind:
185+
186+
1. **Database Migrations**: After switching branches or making changes to the database structure, always run migrations:
187+
```bash
188+
docker exec -it coolify php artisan migrate
189+
```
190+
191+
2. **Resetting Development Setup**: To reset your development setup to a clean database with default values:
192+
```bash
193+
docker exec -it coolify php artisan migrate:fresh --seed
194+
```
195+
196+
3. **Troubleshooting**: If you encounter unexpected behavior, ensure your database is up-to-date with the latest migrations and if possible reset the development setup to eliminate any environment-specific issues.
197+
198+
> [!IMPORTANT]
199+
> Forgetting to migrate the database can cause problems, so make it a habit to run migrations after pulling changes or switching branches.
200+
201+
## Resetting Development Environment
202+
203+
If you encounter issues or break your database or something else, follow these steps to start from a clean slate (works since `v4.0.0-beta.342`):
204+
205+
1. Stop all running containers `ctrl + c`.
206+
207+
2. Remove all Coolify containers:
208+
```bash
209+
docker rm coolify coolify-db coolify-redis coolify-realtime coolify-testing-host coolify-minio coolify-vite-1 coolify-mail
210+
```
211+
212+
3. Remove Coolify volumes (it is possible that the volumes have no `coolify` prefix on your machine, in that case remove the prefix from the command):
213+
```bash
214+
docker volume rm coolify_dev_backups_data coolify_dev_postgres_data coolify_dev_redis_data coolify_dev_coolify_data coolify_dev_minio_data
215+
```
216+
217+
4. Remove unused images:
218+
```bash
219+
docker image prune -a
220+
```
221+
222+
5. Start Coolify again:
223+
```bash
224+
spin up
225+
```
226+
227+
6. Run database migrations and seeders:
228+
```bash
229+
docker exec -it coolify php artisan migrate:fresh --seed
230+
```
231+
232+
After completing these steps, you'll have a fresh development setup.
233+
234+
> [!IMPORTANT]
235+
> Always run database migrations and seeders after switching branches or pulling updates to ensure your local database structure matches the current codebase and includes necessary seed data.
236+
201237
## Additional Contribution Guidelines
202238

203239
### Contributing a New Service

other/nightly/.env.development.example

Lines changed: 0 additions & 34 deletions
This file was deleted.

0 commit comments

Comments
 (0)