forked from github/plane
6eb7014ea4
* update github readme, add new features and deployment options * add new product screenshots * add contributors section to readme * chore: update formatting
200 lines
8.4 KiB
Markdown
200 lines
8.4 KiB
Markdown
<br /><br />
|
|
|
|
<p align="center">
|
|
<a href="https://plane.so">
|
|
<img src="https://plane-marketing.s3.ap-south-1.amazonaws.com/plane-readme/plane_logo_.webp" alt="Plane Logo" width="70">
|
|
</a>
|
|
</p>
|
|
|
|
<h3 align="center"><b>Plane</b></h3>
|
|
<p align="center"><b>Open-source project management that unlocks customer value.</b></p>
|
|
|
|
<p align="center">
|
|
<a href="https://discord.com/invite/A92xrEGCge">
|
|
<img alt="Discord online members" src="https://img.shields.io/discord/1031547764020084846?color=5865F2&label=Discord&style=for-the-badge" />
|
|
</a>
|
|
<img alt="Commit activity per month" src="https://img.shields.io/github/commit-activity/m/makeplane/plane?style=for-the-badge" />
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="http://www.plane.so"><b>Website</b></a> •
|
|
<a href="https://github.com/makeplane/plane/releases"><b>Releases</b></a> •
|
|
<a href="https://twitter.com/planepowers"><b>Twitter</b></a> •
|
|
<a href="https://docs.plane.so/"><b>Documentation</b></a>
|
|
</p>
|
|
|
|
<p>
|
|
<a href="https://app.plane.so/#gh-light-mode-only" target="_blank">
|
|
<img
|
|
src="https://plane-marketing.s3.ap-south-1.amazonaws.com/plane-readme/plane_screen.webp"
|
|
alt="Plane Screens"
|
|
width="100%"
|
|
/>
|
|
</a>
|
|
<a href="https://app.plane.so/#gh-dark-mode-only" target="_blank">
|
|
<img
|
|
src="https://plane-marketing.s3.ap-south-1.amazonaws.com/plane-readme/plane_screens_dark_mode.webp"
|
|
alt="Plane Screens"
|
|
width="100%"
|
|
/>
|
|
</a>
|
|
</p>
|
|
|
|
Meet [Plane](https://plane.so). An open-source software development tool to manage issues, sprints, and product roadmaps with peace of mind. 🧘♀️
|
|
|
|
> Plane is still in its early days, not everything will be perfect yet, and hiccups may happen. Please let us know of any suggestions, ideas, or bugs that you encounter on our [Discord](https://discord.com/invite/A92xrEGCge) or GitHub issues, and we will use your feedback to improve on our upcoming releases.
|
|
|
|
|
|
|
|
## ⚡ Installation
|
|
|
|
The easiest way to get started with Plane is by creating a [Plane Cloud](https://app.plane.so) account where we offer a hosted solution for users.
|
|
|
|
If you want more control over your data prefer to self-host Plane, please refer to our [deployment documentation](https://docs.plane.so/docker-compose).
|
|
|
|
| Installation Methods | Documentation Link |
|
|
|-----------------|----------------------------------------------------------------------------------------------------------|
|
|
| Docker | [](https://docs.plane.so/docker-compose) |
|
|
| Kubernetes | [](https://docs.plane.so/kubernetes) |
|
|
|
|
`Instance admin` can configure instance settings using our [God-mode](https://docs.plane.so/instance-admin) feature.
|
|
|
|
## 🚀 Features
|
|
|
|
- **Issues**: Quickly create issues and add details using a powerful, rich text editor that supports file uploads. Add sub-properties and references to problems for better organization and tracking.
|
|
|
|
- **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.
|
|
|
|
|
|
|
|
## 🛠️ Contributors Quick Start
|
|
|
|
> Development system must have docker engine installed and running.
|
|
|
|
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 <feature-branch-name>
|
|
```
|
|
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](./ENV_SETUP.md) 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!
|
|
|
|
## ❤️ Community
|
|
|
|
The Plane community can be found on [GitHub Discussions](https://github.com/orgs/makeplane/discussions), and our [Discord server](https://discord.com/invite/A92xrEGCge). Our [Code of conduct](https://github.com/makeplane/plane/blob/master/CODE_OF_CONDUCT.md) applies to all Plane community chanels.
|
|
|
|
Ask questions, report bugs, join discussions, voice ideas, make feature requests, or share your projects.
|
|
|
|
### Repo Activity
|
|
|
|
|
|
## 📸 Screenshots
|
|
|
|
<p>
|
|
<a href="https://plane.so" target="_blank">
|
|
<img
|
|
src="https://ik.imagekit.io/w2okwbtu2/Issues_rNZjrGgFl.png?updatedAt=1709298765880"
|
|
alt="Plane Views"
|
|
width="100%"
|
|
/>
|
|
</a>
|
|
</p>
|
|
<p>
|
|
<a href="https://plane.so" target="_blank">
|
|
<img
|
|
src="https://ik.imagekit.io/w2okwbtu2/Cycles_jCDhqmTl9.png?updatedAt=1709298780697"
|
|
width="100%"
|
|
/>
|
|
</a>
|
|
</p>
|
|
<p>
|
|
<a href="https://plane.so" target="_blank">
|
|
<img
|
|
src="https://ik.imagekit.io/w2okwbtu2/Modules_PSCVsbSfI.png?updatedAt=1709298796783"
|
|
alt="Plane Cycles and Modules"
|
|
width="100%"
|
|
/>
|
|
</a>
|
|
</p>
|
|
<p>
|
|
<a href="https://plane.so" target="_blank">
|
|
<img
|
|
src="https://ik.imagekit.io/w2okwbtu2/Views_uxXsRatS4.png?updatedAt=1709298834522"
|
|
alt="Plane Analytics"
|
|
width="100%"
|
|
/>
|
|
</a>
|
|
</p>
|
|
<p>
|
|
<a href="https://plane.so" target="_blank">
|
|
<img
|
|
src="https://ik.imagekit.io/w2okwbtu2/Analytics_0o22gLRtp.png?updatedAt=1709298834389"
|
|
alt="Plane Pages"
|
|
width="100%"
|
|
/>
|
|
</a>
|
|
</p>
|
|
</p>
|
|
<p>
|
|
<a href="https://plane.so" target="_blank">
|
|
<img
|
|
src="https://ik.imagekit.io/w2okwbtu2/Drive_LlfeY4xn3.png?updatedAt=1709298837917"
|
|
alt="Plane Command Menu"
|
|
width="100%"
|
|
/>
|
|
</a>
|
|
</p>
|
|
</p>
|
|
|
|
## ⛓️ Security
|
|
|
|
If you believe you have found a security vulnerability in Plane, we encourage you to responsibly disclose this and not open a public issue. We will investigate all legitimate reports.
|
|
|
|
Email squawk@plane.so to disclose any security vulnerabilities.
|
|
|
|
## ❤️ Contribute
|
|
|
|
There are many ways to contribute to Plane, including:
|
|
- Submitting [bugs](https://github.com/makeplane/plane/issues/new?assignees=srinivaspendem%2Cpushya22&labels=%F0%9F%90%9Bbug&projects=&template=--bug-report.yaml&title=%5Bbug%5D%3A+) and [feature requests](https://github.com/makeplane/plane/issues/new?assignees=srinivaspendem%2Cpushya22&labels=%E2%9C%A8feature&projects=&template=--feature-request.yaml&title=%5Bfeature%5D%3A+) for various components.
|
|
- Reviewing [the documentation](https://docs.plane.so/) and submitting [pull requests](https://github.com/makeplane/plane), from fixing typos to adding new features.
|
|
- Speaking or writing about Plane or any other ecosystem integration and [letting us know](https://discord.com/invite/A92xrEGCge)!
|
|
- Upvoting [popular feature requests](https://github.com/makeplane/plane/issues) to show your support.
|
|
|
|
### We couldn't have done this without you.
|
|
|
|
<a href="https://github.com/makeplane/plane/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=makeplane/plane" />
|
|
</a> |