From a80423aefc79ca155f4a1575984952a5c107963c Mon Sep 17 00:00:00 2001 From: danciaclara Date: Tue, 10 Dec 2024 21:01:53 +0530 Subject: [PATCH 1/3] Updated README.md --- README.md | 131 +++++++++++++++++++++++++++++------------------------- 1 file changed, 71 insertions(+), 60 deletions(-) diff --git a/README.md b/README.md index 38ead5f9970..9b085fe5108 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,10 @@

- Plane Logo + Plane Logo

-

Plane

-

Open-source project management that unlocks customer value

-

Discord online members @@ -44,79 +41,83 @@ Meet [Plane](https://dub.sh/plane-website-readme), an open-source project manage > Plane is evolving every day. Your suggestions, ideas, and reported bugs help us immensely. Do not hesitate to join in the conversation on [Discord](https://discord.com/invite/A92xrEGCge) or raise a GitHub issue. We read everything and respond to most. -## ⚡ Installation +## 🚀 Installation + +Getting started with Plane is simple. Choose the setup that works best for you: -The easiest way to get started with Plane is by creating a [Plane Cloud](https://app.plane.so) account. +- **Plane Cloud** +Sign up for a free account on [Plane Cloud](https://app.plane.so)—it's the fastest way to get up and running without worrying about infrastructure. -If you would like to self-host Plane, please see our [deployment guide](https://docs.plane.so/docker-compose). +- **Self-host Plane** +Prefer full control over your data and infrastructure? Install and run Plane on your own servers. Follow our detailed [deployment guides](https://docs.plane.so/docker-compose) to get started. | Installation methods | Docs link | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Docker | [![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white)](https://docs.plane.so/self-hosting/methods/docker-compose) | -| Kubernetes | [![Kubernetes](https://img.shields.io/badge/kubernetes-%23326ce5.svg?style=for-the-badge&logo=kubernetes&logoColor=white)](https://docs.plane.so/kubernetes) | +| Docker | [![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white)](https://developers.plane.so/self-hosting/methods/docker-compose) | +| Kubernetes | [![Kubernetes](https://img.shields.io/badge/kubernetes-%23326ce5.svg?style=for-the-badge&logo=kubernetes&logoColor=white)](https://developers.plane.so/self-hosting/methods/kubernetes) | -`Instance admins` can configure instance settings with [God-mode](https://docs.plane.so/instance-admin). +`Instance admins` can manage and customize settings using [God mode](https://developers.plane.so/self-hosting/govern/instance-admin). -## 🚀 Features +## 🌟 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. +- **Issues** +Efficiently create and manage tasks with a robust rich text editor that supports file uploads. Enhance organization and tracking by adding sub-properties and referencing related issues. -- **Cycles**: - Keep up your team's momentum with Cycles. Gain insights into your project's progress with burn-down charts and other valuable features. +- **Cycles** +Maintain your team’s momentum with Cycles. Track progress effortlessly using burn-down charts and other insightful tools. -- **Modules**: Break down your large projects into smaller, more manageable modules. Assign modules between teams to track and plan your project's progress easily. +- **Modules** +Simplify complex projects by dividing them into smaller, manageable modules. -- **Views**: Create custom filters to display only the issues that matter to you. Save and share your filters in just a few clicks. +- **Views** +Customize your workflow by creating filters to display only the most relevant issues. Save and share these views with ease. -- **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. +- **Pages** +Capture and organize ideas using Plane Pages, complete with AI capabilities and a rich text editor. Format text, insert images, add hyperlinks, or convert your notes into actionable items. -- **Analytics**: Get insights into all your Plane data in real-time. Visualize issue data to spot trends, remove blockers, and progress your work. +- **Analytics** +Access real-time insights across all your Plane data. Visualize trends, remove blockers, and keep your projects moving forward. -- **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. -## 🛠️ Quick start for contributors +## 🛠️ Local development -> Development system must have docker engine installed and running. +### Pre-requisites +- Ensure Docker Engine is installed and running. -Setting up local environment is extremely easy and straight forward. Follow the below step and you will be ready to contribute - +### Development setup +Setting up your local environment is simple and straightforward. Follow these steps to get started: -1. Clone the code locally using: +1. Clone the repository: ``` git clone https://github.com/makeplane/plane.git ``` -2. Switch to the code folder: +2. Navigate to the project folder: ``` cd plane ``` -3. Create your feature or fix branch you plan to work on using: +3. Create a new branch for your feature or fix: ``` git checkout -b ``` -4. Open terminal and run: +4. Run the setup script in the terminal: ``` ./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: +5. Open the project in an IDE such as VS Code. + +6. Review the `.env` files in the relevant folders. Refer to [Environment Setup](./ENV_SETUP.md) for details on the environment variables used. + +7. Start the services using Docker: ``` 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. +That’s it! You’re all set to begin coding. Remember to refresh your browser if changes don’t auto-reload. Happy contributing! 🎉 -Ask questions, report bugs, join discussions, voice ideas, make feature requests, or share your projects. - -### Repo Activity - -![Plane Repo Activity](https://repobeats.axiom.co/api/embed/2523c6ed2f77c082b7908c33e2ab208981d76c39.svg "Repobeats analytics image") +## Built with +[![Next JS](https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white)](https://nextjs.org/)
+[![Django](https://img.shields.io/badge/Django-092E20?style=for-the-badge&logo=django&logoColor=green)](https://www.djangoproject.com/)
+[![Node JS](https://img.shields.io/badge/node.js-339933?style=for-the-badge&logo=Node.js&logoColor=white)](https://nodejs.org/en) ## 📸 Screenshots @@ -165,34 +166,44 @@ Ask questions, report bugs, join discussions, voice ideas, make feature requests

-

- - Plane Command Menu - -

-## ⛓️ Security +## 📝 Documentation +Explore Plane's [product documentation](https://docs.plane.so/) and [developer documentation](https://developers.plane.so/) to learn about features, setup, and usage. + +## ❤️ Community + +Join the Plane community on [GitHub Discussions](https://github.com/orgs/makeplane/discussions) and our [Discord server](https://discord.com/invite/A92xrEGCge). We follow a [Code of conduct](https://github.com/makeplane/plane/blob/master/CODE_OF_CONDUCT.md) in all our community channels. + +Feel free to ask questions, report bugs, participate in discussions, share ideas, request features, or showcase your projects. We’d love to hear from you! -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. +## 🛡️ Security -Email squawk@plane.so to disclose any security vulnerabilities. +If you discover a security vulnerability in Plane, please report it responsibly instead of opening a public issue. We take all legitimate reports seriously and will investigate them promptly. See [Security policy](https://github.com/makeplane/plane/blob/master/SECURITY.md) for more info. -## ❤️ Contribute +To disclose any security issues, please email us at security@plane.so. -There are many ways to contribute to Plane, including: +## 🤝 Contributing -- 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. +There are many ways you can contribute to Plane: + +- Report [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+) or submit [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+). +- Review the [documentation](https://docs.plane.so/) and submit [pull requests](https://github.com/makeplane/docs) to improve it—whether it's fixing typos or adding new content. +- Talk or write about Plane or any other ecosystem integration and [let us know](https://discord.com/invite/A92xrEGCge)! +- Show your support by upvoting [popular feature requests](https://github.com/makeplane/plane/issues). + +Please read [CONTRIBUTING.md](https://github.com/makeplane/plane/blob/master/CONTRIBUTING.md) for details on the process for submitting pull requests to us. + +### Repo activity + +![Plane Repo Activity](https://repobeats.axiom.co/api/embed/2523c6ed2f77c082b7908c33e2ab208981d76c39.svg "Repobeats analytics image") ### We couldn't have done this without you. + + +## License +This project is licensed under the [GNU Affero General Public License v3.0](https://github.com/makeplane/plane/blob/master/LICENSE.txt). \ No newline at end of file From b3623d458998905a874f1e8c8417d1afdb540327 Mon Sep 17 00:00:00 2001 From: danciaclara Date: Thu, 12 Dec 2024 18:23:43 +0530 Subject: [PATCH 2/3] minor fixes --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b085fe5108..accbc5f7da8 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,10 @@

- Plane Logo + Plane Logo

+

Plane

@@ -78,6 +79,8 @@ Capture and organize ideas using Plane Pages, complete with AI capabilities and - **Analytics** Access real-time insights across all your Plane data. Visualize trends, remove blockers, and keep your projects moving forward. +- **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. + ## 🛠️ Local development @@ -166,6 +169,16 @@ That’s it! You’re all set to begin coding. Remember to refresh your browser

+

+ Coming soon + + Plane Command Menu + +

## 📝 Documentation From 4b676b248c650c0d2b9ff4243ad8975556f46199 Mon Sep 17 00:00:00 2001 From: danciaclara Date: Thu, 12 Dec 2024 18:30:28 +0530 Subject: [PATCH 3/3] minor fixes --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index accbc5f7da8..9c4ea9da614 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ Getting started with Plane is simple. Choose the setup that works best for you: Sign up for a free account on [Plane Cloud](https://app.plane.so)—it's the fastest way to get up and running without worrying about infrastructure. - **Self-host Plane** -Prefer full control over your data and infrastructure? Install and run Plane on your own servers. Follow our detailed [deployment guides](https://docs.plane.so/docker-compose) to get started. +Prefer full control over your data and infrastructure? Install and run Plane on your own servers. Follow our detailed [deployment guides](https://developers.plane.so/self-hosting/overview) to get started. | Installation methods | Docs link | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | @@ -170,7 +170,6 @@ That’s it! You’re all set to begin coding. Remember to refresh your browser

- Coming soon