-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #703 from makeplane/stage-release
promote: stage-release to production
- Loading branch information
Showing
55 changed files
with
2,007 additions
and
473 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,50 +2,143 @@ | |
|
||
<p align="center"> | ||
<a href="https://plane.so"> | ||
<img src="https://res.cloudinary.com/dgxawjvpo/image/upload/v1673379660/Plane/plane-logo_0m83xue7R_f0v9r9.png" alt="Plane Logo" width="350"> | ||
<img src="https://res.cloudinary.com/toolspacedev/image/upload/v1680596414/Plane/Plane_Icon_Blue_on_White_150x150_muysa3.jpg" alt="Plane Logo" width="70"> | ||
</a> | ||
</p> | ||
|
||
<h3 align="center"><b>Plane</b></h3> | ||
<p align="center"><b>Open-source, self-hosted project planning tool</b></p> | ||
|
||
<p align="center"> | ||
<a href="https://discord.com/invite/A92xrEGCge"> | ||
<img alt="Discord" src="https://img.shields.io/discord/1031547764020084846?color=5865F2&label=Discord&style=for-the-badge" /> | ||
</a> | ||
<img alt="Discord" src="https://img.shields.io/github/commit-activity/m/makeplane/plane?style=for-the-badge" /> | ||
</p> | ||
|
||
<br /> | ||
Plane is an open-source project planning tool that is designed to help individuals and teams streamline their issues, sprints, and product roadmaps. It is easy to use and can be accessed by anyone, making it an ideal choice for a wide range of projects and organizations. | ||
<br /> <br /> | ||
<p> | ||
<a href="https://app.plane.so/" target="_blank"> | ||
<img | ||
src="https://res.cloudinary.com/toolspacedev/image/upload/v1680599798/Plane/plane_1_1_tnb32j.png" | ||
alt="Plane Screens" | ||
width="100%" | ||
/> | ||
</a> | ||
</p> | ||
|
||
Meet Plane. 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/29tPNhaV) or GitHub issues, and we will use your feedback to improve on our upcoming releases. | ||
## Getting Started | ||
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 | ||
|
||
### Docker Compose Setup | ||
|
||
- Clone the Repository | ||
|
||
```bash | ||
git clone https://github.com/makeplane/plane | ||
``` | ||
|
||
- Change Directory | ||
|
||
```bash | ||
cd plane | ||
``` | ||
|
||
- Run setup.sh | ||
|
||
```bash | ||
./setup.sh localhost | ||
``` | ||
|
||
Visit https://app.plane.so to get started with Plane. | ||
> If running in a cloud env replace localhost with public facing IP address of the VM | ||
## Documentation | ||
|
||
- Run Docker compose up | ||
|
||
```bash | ||
docker-compose up | ||
``` | ||
|
||
|
||
## 🚀 Features | ||
|
||
* **Issue Planning and Tracking**: Quickly create issues and add details using a powerful rich text editor that supports file uploads. Add sub-properties and references to issues for better organization and tracking. | ||
* **Issue Attachments**: Collaborate effectively by attaching files to issues, making it easy for your team to find and share important project-related documents. | ||
* **Layouts**: Customize your project view with your preferred layout - choose from List, Kanban, or Calendar to visualize your project in a way that makes sense to you. | ||
* **Cycles**: Plan sprints with Cycles to keep your team on track and productive. Gain insights into your project's progress with burn-down charts and other useful features. | ||
* **Modules**: Break down your large projects into smaller, more manageable modules. Assign modules between teams to easily track and plan your project's progress. | ||
* **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 function as an AI-powered notepad, allowing you to easily document issues, cycle plans, and module details, and then synchronize them with your issues. | ||
* **Command K**: Enjoy a better user experience with the new Command + K menu. Easily manage and navigate through your projects from one convenient location. | ||
* **GitHub Sync**: Streamline your planning process by syncing your GitHub issues with Plane. Keep all your issues in one place for better tracking and collaboration. | ||
|
||
## 📸 Screenshots | ||
|
||
<p> | ||
<a href="https://app.plane.so/" target="_blank"> | ||
<img | ||
src="https://res.cloudinary.com/toolspacedev/image/upload/v1680601719/Plane/plane_2_iqao52.png" | ||
alt="Plane Issue Details" | ||
width="100%" | ||
/> | ||
</a> | ||
</p> | ||
<p> | ||
<a href="https://app.plane.so/" target="_blank"> | ||
<img | ||
src="https://res.cloudinary.com/toolspacedev/image/upload/v1680604273/Plane/plane_5_1_nwsl3a.png" | ||
alt="Plane Cycles and Modules" | ||
width="100%" | ||
/> | ||
</a> | ||
</p> | ||
<p> | ||
<a href="https://app.plane.so/" target="_blank"> | ||
<img | ||
src="https://res.cloudinary.com/toolspacedev/image/upload/v1680601713/Plane/plane_4_cqm0g8.png" | ||
alt="Plane Quick Lists" | ||
width="100%" | ||
/> | ||
</a> | ||
</p> | ||
<p> | ||
<a href="https://app.plane.so/" target="_blank"> | ||
<img | ||
src="https://res.cloudinary.com/toolspacedev/image/upload/v1680601712/Plane/plane_3_1_cu4fsc.png" | ||
alt="Plane Command K" | ||
width="100%" | ||
/> | ||
</a> | ||
</p> | ||
|
||
## 📚Documentation | ||
|
||
For full documentation, visit [docs.plane.so](https://docs.plane.so/) | ||
|
||
To see how to Contribute, visit [here](https://github.com/makeplane/plane/blob/master/CONTRIBUTING.md). | ||
|
||
## Status | ||
|
||
## 🔋 Status | ||
|
||
- [x] Early Community Previews: We are open-sourcing and sharing the development version of Plane | ||
- [ ] Alpha: We are testing Plane with a closed set of customers | ||
- [ ] Public Alpha: Anyone can sign up over at [app.plane.so](https://app.plane.so). But go easy on us, there are a few hiccups | ||
- [ ] Public Beta: Stable enough for most non-enterprise use-cases | ||
- [ ] Public: Production-ready | ||
|
||
## Community | ||
## ❤️ Community | ||
|
||
The Plane community can be found on GitHub Discussions, where you can ask questions, voice ideas, and share your projects. | ||
|
||
To chat with other community members you can join the [Plane Discord](https://discord.com/invite/q9HKAdau). | ||
|
||
Our [Code of Conduct](https://github.com/makeplane/plane/blob/master/CODE_OF_CONDUCT.md) applies to all Plane community channels. | ||
|
||
## Security | ||
## ⛓️ 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 [email protected] to disclose any security vulnerabilities. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,3 +19,6 @@ GITHUB_CLIENT_SECRET="" | |
# Flags | ||
DISABLE_COLLECTSTATIC=1 | ||
DOCKERIZED=1 | ||
# GPT Envs | ||
OPENAI_API_KEY=0 | ||
GPT_ENGINE=0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
3d6f2dd
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
plane – ./apps/app
plane-git-master-caravel.vercel.app
plane-caravel.vercel.app
app.plane.so
plane-theta.vercel.app