Skip to content

Samsonroyal/Clearpath

Repository files navigation

Clearpath Logo

Description

Clearpath is a lightweight and efficient project management tool designed to help teams effectively plan, track, and deliver projects. With its intuitive interface and powerful features, Clearpath streamlines project management processes, enabling teams to stay organized and collaborate seamlessly.

Table of Contents

  1. Usage
  2. Contributing
  3. License

Features

  • Intuitive User Interface: Clearpath boasts a visually appealing and user-friendly interface that ensures easy navigation and access to features.
  • Task Management: Create, assign, track, update, and prioritize tasks with ease, empowering teams to stay on top of project deliverables.
  • Filtering, Sorting, and Grouping: Organize and visualize tasks in various formats (cards, lists, grids, or tables) using powerful filtering, sorting, and grouping capabilities.
  • Automated Tracking: Stay up-to-date with automated progress reports, notifications, and reminders based on task updates and project milestones.
  • Integrated Communication: Clearpath facilitates efficient communication among team members through integrated channels, fostering collaboration and minimizing context switching.

Usage

MORE THAN your regular Project management tool. cleaner, sexier, no clutter which means more focus for you.

Getting Started

To get started with Clearpath, follow these steps:

  1. Clone the repository: git clone https://github.com/Samsonroyal/clearpath.git
  2. change directory: cd clearpath
  3. Install dependencies: npm install
  4. Run the application npm run dev

Contributing

We welcome contributions from the community. Please read the Contributing Guidelines before making any contributions.

  1. Clone the repository by clicking on code button and choose either Github Desktop or CLI As seen in the image below image

  2. Create a new branch: git checkout -branch your-branch-name

  3. Make your changes; ensure to periodically stage the changes

  4. Build the application; before you commit changes to production always ensure to run this command npm run build

  5. Commit the changes: git commit -m 'Add some feature'

  6. Push to the branch: git push origin my-new-feature

  7. Submit a pull request

  8. Assign someone to review your PR before it's merged into the main branch.

Documentation

Detailed documentation for Clearpath can be found in the docs directory.

License

Clearpath is licensed under the MIT License.

Support

If you need help or have any questions, please open an issue on the GitHub repository.