midocean-technologies / plane-mobile Goto Github PK

Open-source project planning tool

Meet Plane. An open-source software development tool to manage issues, sprints, and product roadmaps with peace of mind 🧘‍♀️.

Plane Mobile 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 or GitHub issues, and we will use your feedback to improve on our upcoming releases.

Introducing Plane Mobile, the ultimate tool at your fingertips for managing critical tasks. Our mobile app allows you to effortlessly perform the project-related tasks and effectively manage your projects. Plane Mobile is developed using the latest and most suitable tech stack, which includes Flutter and Dart for the front-end, and Python with Django for the back-end. We rely on PostgreSQL as our primary database and leverage Redis for efficient background task management. To begin using Plane Mobile, get started by exploring our setup section below.

Step 1: Install the Required Tools

For Windows: Install JDK, Flutter SDK, Dart SDK, and Android Studio. To learn more about the setup on Windows, please refer to the Flutter documentation.

For macOS: Install Xcode, Homebrew, JDK, Flutter, Dart, and Cocoapods. To learn more about the setup on macOS, please visit the Flutter documentation.

Step 2: Clone the Repository

Step 3: Create the .env file

1. Create a file named .env in the project's root directory.
2. Define the variables BASE_API (required) and UNSPLASH_API_KEY (optional) in the .env file and initialize them.

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

For full documentation, visit docs.plane.so

To see how to Contribute, visit here.

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.

Our Code of Conduct applies to all Plane community channels.

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.