🌱

Sprout

An open-source self-hostable project manager with collaboration support.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Sprout is an open source self-hostable project manager with collaboration support.

It applies various known methods such as GTD, Kanban and Lists. Within the user interface, you are able to switch and organise your tasks by any of these methods at will.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

With NodeJS

1. Clone the repository and navigate to the created folder

   git clone https://github.com/NebSpacefarer/sprout.git && cd sprout
   

2. Install NPM packages

   pnpm install
   

3. Run your Sprout instance

   pnpm start
   

With Docker Compose

1. Clone the repo

   git clone https://github.com/NebSpacefarer/sprout.git
   

2. Inspect docker-compose.yml and customize to your needs.
3. Run through Docker Compose

   sudo docker compose up -d
   

(back to top)

Usage

Once installation is complete, your very own Sprout instance should be available by default at http://localhost:3535 .

This is susceptible to change if you have customized your instance with a custom port, or if you apply a reverse proxy to the web app.

For more guides and examples, please refer to the Documentation

(back to top)

Roadmap

• ...

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

AI-generated content and code are prohibited within the scope of this repository and project. Please refrain from vibe-coding features or any documentation or AI-generating images for this project.

If you have a suggestion that would make the project better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors:

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

NebSpacefarer - @Nebspacefarer - contact .at. nebspacefarer .dot. com

Project Link: https://github.com/NebSpacefarer/sprout

Discord Community: https://discord.com/invite/...

(back to top)

Acknowledgments

(back to top)