davenchy/project-manager repository overview

This Docker image contains the backend server for the ALX Software Engineering portfolio project, a robust project management tool designed to enhance team collaboration. Built with TypeScript, Hono, MongoDB, and Zod, the backend supports key features such as workspaces, projects, tasks, and real-time updates via Server-Sent Events (SSE). The project is part of a micro-repo structure, with separate repositories for the frontend and other components.

The GitHub Repository⁠

⁠Features

• Workspaces & Projects: Organize your work by grouping related projects together.
• Tasks & To-Do Lists: Track progress with detailed tasks and sub-tasks.
• Real-Time Updates: Stay synchronized with Server-Sent Events (SSE) for live collaboration.
• API Documentation: Comprehensive Swagger documentation is available at /docs for easy API reference.

⁠Quick Start

To get started quickly, pull the Docker image:

docker run --name pm-backend -d -p 5000:5000 -e SERVER_HOST=0.0.0.0 -e DB_HOST=0.0.0.0 davenchy/project-manager:beta

You can also use the included docker-compose.yml file on the GitHub repository to set up both the backend server and the MongoDB database:

docker-compose up -d

This setup makes it simple to get the project up and running with minimal configuration.

⁠Project Information

This project is part of the ALX Software Engineering (SE) portfolio, showcasing the application of modern development practices and tools in a collaborative environment.

⁠License

This project is licensed under the MIT License. Feel free to use, modify, and distribute as per the license terms.

⁠Contributing

We welcome contributions from the community.