references/plane
1
0
Fork 0
mirror of https://github.com/makeplane/plane.git synced 2026-06-14 03:30:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

dev: Docker Compose for Local Dev Environment Setup (#2409)

Browse Source 
* local dev environment setup

* api image fixes

* yaml changed to yml

* Readme & EnvSetup MD updates

* Update README.md
This commit is contained in:
Manish Gupta
2023-10-13 12:16:08 +05:30
committed by GitHub
parent 0a8b99a074
commit c6e021d41f
7 changed files with 396 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+16 -18
View File
@@ -39,33 +39,31 @@ Meet [Plane](https://plane.so). An open-source software development tool to mana
The easiest way to get started with Plane is by creating a [Plane Cloud](https://app.plane.so) account. Plane Cloud offers a hosted solution for Plane. If you prefer to self-host Plane, please refer to our [deployment documentation](https://docs.plane.so/self-hosting).
## ⚡️ Quick start with Docker Compose
## ⚡️ Contributors Quick Start
### Docker Compose Setup
### Prerequisite
Development system must have docker engine installed and running.
- Clone the repository
```bash
git clone https://github.com/makeplane/plane
cd plane
chmod +x setup.sh
```
### Steps
Setting up local environment is extremely easy and straight forward. Follow the below step and you will be ready to contribute
- Run setup.sh
1. Clone the code locally using `git clone https://github.com/makeplane/plane.git`
1. Switch to the code folder `cd plane`
1. Create your feature or fix branch you plan to work on using `git checkout -b <feature-branch-name>`
1. Open terminal and run `./setup.sh`
1. Open the code on VSCode or similar equivalent IDE
1. Review the `.env` files available in various folders. Visit [Environment Setup](./ENV_SETUP.md) to know about various environment variables used in system
1. Run the docker command to initiate various services `docker compose -f docker-compose-local.yml up -d`
```bash
./setup.sh
```
You are ready to make changes to the code. Do not forget to refresh the browser (in case id does not auto-reload)
> If running in a cloud env replace localhost with public facing IP address of the VM
Thats it!
- Run Docker compose up
```bash
docker compose up -d
```
## 🍙 Self Hosting
<strong>You can use the default email and password for your first login `captain@plane.so` and `password123`.</strong>
For self hosting environment setup, visit the [Self Hosting](https://docs.plane.so/self-hosting) documentation page
## 🚀 Features