Plane

Plane is an extensible, open source project and product management tool. It allows users to start with a basic task tracking tool and gradually adopt various project management frameworks like Agile, Waterfall, and many more.

• Cycles: Keep up your team's momentum with Cycles. Gain insights into your project's progress with burn-down charts and other valuable features.

• Modules: Break down your large projects into smaller, more manageable modules. Assign modules between teams to track and plan your project's progress easily.

• Views: Create custom filters to display only the issues that matter to you. Save and share your filters in just a few clicks.

• Pages: Plane pages, equipped with AI and a rich text editor, let you jot down your thoughts on the fly. Format your text, upload images, hyperlink, or sync your existing ideas into an actionable item or issue.

• Analytics: Get insights into all your Plane data in real-time. Visualize issue data to spot trends, remove blockers, and progress your work.

• Drive (coming soon): The drive helps you share documents, images, videos, or any other files that make sense to you or your team and align on the problem/solution.

Setting up local environment is extremely easy and straight forward. Follow the below step and you will be ready to contribute -

1. Clone the code locally using:

   git clone https://github.com/makeplane/plane.git
   

2. Switch to the code folder:

   cd plane
   

3. Create your feature or fix branch you plan to work on using:

   git checkout -b 
   

4. Open terminal and run:

   ./setup.sh
   

5. Open the code on VSCode or similar equivalent IDE.
6. Review the .env files available in various folders. Visit Environment Setup to know about various environment variables used in system.
7. Run the docker command to initiate services:

   docker compose -f docker-compose-local.yml up -d
   

You are ready to make changes to the code. Do not forget to refresh the browser (in case it does not auto-reload).

Thats it!