🔥 🔥 🔥 Open Source JIRA, Linear and Height Alternative. Plane helps you track your issues, epics, and product roadmaps in the simplest way possible.
Go to file
sriram veeraghanta 092e65b43d
[WEB-1424] chore: page and view logo implementation, and emoji/icon (#4662)
* [WEB-1424] chore: page and view logo implementation, and emoji/icon picker improvement (#4583)

* chore: added logo_props

* chore: logo props in cycles, views and modules

* chore: emoji icon picker types updated

* chore: info icon added to plane ui package

* chore: icon color adjust helper function added

* style: icon picker ui improvement and default color options updated

* chore: update page logo action added in store

* chore: emoji code to unicode helper function added

* chore: common logo renderer component added

* chore: app header project logo updated

* chore: project logo updated across platform

* chore: page logo picker added

* chore: control link component improvement

* chore: list item improvement

* chore: emoji picker component updated

* chore: space app and package logo prop type updated

* chore: migration

* chore: logo added to project view

* chore: page logo picker added in create modal and breadcrumbs

* chore: view logo picker added in create modal and updated breadcrumbs

* fix: build error

* chore: AIO docker images for preview deployments (#4605)

* fix: adding single docker base file

* action added

* fix action

* dockerfile.base modified

* action fix

* dockerfile

* fix: base aio dockerfile

* fix: dockerfile.base

* fix: dockerfile base

* fix: modified folder structure

* fix: action

* fix: dockerfile

* fix: dockerfile.base

* fix: supervisor file name changed

* fix: base dockerfile updated

* fix dockerfile base

* fix: base dockerfile

* fix: docker files

* fix: base dockerfile

* update base image

* modified docker aio base

* aio base modified to debian-12-slim

* fixes

* finalize the dockerfiles with volume exposure

* modified the aio build and dockerfile

* fix: codacy suggestions implemented

* fix: codacy fix

* update aio build action

---------

Co-authored-by: sriram veeraghanta <veeraghanta.sriram@gmail.com>

* fix: merge conflict

* chore: lucide react added to planu ui package

* chore: new emoji picker component added with lucid icon and code refactor

* chore: logo component updated

* chore: emoji picker updated for pages and views

---------

Co-authored-by: NarayanBavisetti <narayan3119@gmail.com>
Co-authored-by: Manish Gupta <59428681+mguptahub@users.noreply.github.com>
Co-authored-by: sriram veeraghanta <veeraghanta.sriram@gmail.com>

* fix: build error

---------

Co-authored-by: Anmol Singh Bhatia <121005188+anmolsinghbhatia@users.noreply.github.com>
Co-authored-by: NarayanBavisetti <narayan3119@gmail.com>
Co-authored-by: Manish Gupta <59428681+mguptahub@users.noreply.github.com>
Co-authored-by: Anmol Singh Bhatia <anmolsinghbhatia@plane.so>
2024-05-31 14:27:52 +05:30
.github modified the actions to build images correctly (#4635) 2024-05-29 12:40:08 +05:30
.husky WEB-1344 chore: Add storybook (#4490) 2024-05-22 16:36:31 +05:30
admin fix: sentry config update for web app 2024-05-27 15:02:03 +05:30
aio chore: AIO docker images for preview deployments (#4605) 2024-05-28 17:28:02 +05:30
apiserver [WEB-1424] chore: page and view logo implementation, and emoji/icon (#4662) 2024-05-31 14:27:52 +05:30
deploy fix: updated deploy docker compose file with restart no with quotes 2024-05-27 16:51:05 +05:30
nginx chore: AIO docker images for preview deployments (#4605) 2024-05-28 17:28:02 +05:30
packages [WEB-1424] chore: page and view logo implementation, and emoji/icon (#4662) 2024-05-31 14:27:52 +05:30
space [WEB-1424] chore: page and view logo implementation, and emoji/icon (#4662) 2024-05-31 14:27:52 +05:30
web [WEB-1424] chore: page and view logo implementation, and emoji/icon (#4662) 2024-05-31 14:27:52 +05:30
.dockerignore fix: adding sentry configs on space app and updated docker ignore (#3018) 2023-12-07 19:59:35 +05:30
.env.example fix: updated env variables at root (#3390) 2024-01-22 13:21:45 +05:30
.eslintrc-staged.js WEB-1344 chore: Add storybook (#4490) 2024-05-22 16:36:31 +05:30
.eslintrc.js fix: admin app redirections 2024-05-10 15:23:51 +05:30
.gitignore WEB-1344 chore: Add storybook (#4490) 2024-05-22 16:36:31 +05:30
.lintstagedrc.json [WEB-1390] chore: Add pre commit hook to check for lint and formatting errors (#4537) 2024-05-22 15:50:15 +05:30
app.json chore: update single click deployments (#1141) 2023-05-26 14:04:15 +05:30
CODE_OF_CONDUCT.md chore: updated the contact email (#2605) 2023-11-02 16:27:23 +05:30
CONTRIBUTING.md fix: eslint issues and reconfiguring (#3891) 2024-03-06 18:39:14 +05:30
docker-compose-local.yml [WEB-1380] chore: fix sidebar expanding issue on sign out. (#4557) 2024-05-22 20:39:31 +05:30
docker-compose.yml chore: docker entry file name changes 2024-05-22 12:46:41 +05:30
ENV_SETUP.md fix: eslint issues and reconfiguring (#3891) 2024-03-06 18:39:14 +05:30
heroku.yml chore: update single click deployments (#1141) 2023-05-26 14:04:15 +05:30
LICENSE.txt LICENSE change for Plane 2023-06-19 18:47:39 +05:30
package.json [WEB-1390] chore: Add pre commit hook to check for lint and formatting errors (#4537) 2024-05-22 15:50:15 +05:30
README.md Changed tagline, description, and disclaimer (#4382) 2024-05-07 13:56:03 +05:30
SECURITY.md chore: security policy updated 2024-04-09 17:53:09 +05:30
setup.sh fix: auth redirection issues in the web, space and admin apps (#4414) 2024-05-09 17:46:31 +05:30
start.sh [chore] Update setup.sh, with removed replacement script & added project-level ENVs (#2115) 2023-09-13 20:21:02 +05:30
turbo.json fix: posthog proxy config using rewrites 2024-05-28 13:08:37 +05:30
yarn.lock fix: build errors 2024-05-28 15:11:54 +05:30



Plane Logo

Plane

Open-source project management that unlocks customer value

Discord online members Commit activity per month

WebsiteReleasesTwitterDocumentation

Plane Screens Plane Screens

Meet Plane, an open-source project management tool to track issues, run ~sprints~ cycles, and manage product roadmaps without the chaos of managing the tool itself. 🧘‍♀️

Plane is evolving every day. Your suggestions, ideas, and reported bugs help us immensely. Do not hesitate to join in the conversation on Discord or raise a GitHub issue. We read everything and respond to most.

Installation

The easiest way to get started with Plane is by creating a Plane Cloud account.

If you would like to self-host Plane, please see our deployment guide.

Installation methods Docs link
Docker Docker
Kubernetes Kubernetes

Instance admins can configure instance settings with God-mode.

🚀 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.

🛠️ Quick start for contributors

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 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, and our Discord server. Our Code of conduct applies to all Plane community chanels.

Ask questions, report bugs, join discussions, voice ideas, make feature requests, or share your projects.

Repo Activity

Plane Repo Activity

📸 Screenshots

Plane Views

Plane Cycles and Modules

Plane Analytics

Plane Pages

Plane Command Menu

⛓️ 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:

We couldn't have done this without you.