Skip to content

📝 Enhance README with badges, features table, and quick start guide #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Gingiris wants to merge 1 commit into
base: main
Choose a base branch
from
Open

📝 Enhance README with badges, features table, and quick start guide #232

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 77 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,91 @@
<img width="100" src="https://github.com/techulus/manage/blob/main/public/images/logo.png?raw=true" />

## Manage
# Manage

Manage is an open-source project management platform. With its intuitive interface, customizable features, and emphasis on collaboration, Manage empowers teams to enhance productivity and achieve project success. Enjoy the benefits of open-source flexibility, data security, and a thriving community while managing your projects efficiently with Manage.
![License](https://img.shields.io/github/license/techulus/manage)
![Last Commit](https://img.shields.io/github/last-commit/techulus/manage)
![Contributors](https://img.shields.io/github/contributors/techulus/manage)
![Stars](https://img.shields.io/github/stars/techulus/manage)

## Self-Hosting
An open-source project management platform with an intuitive interface, customizable features, and emphasis on collaboration.

Deploy your own instance of Manage with one click:
## ✨ Features

- 🎯 **Intuitive Interface** — Clean, modern UI for seamless project tracking
- 👥 **Team Collaboration** — Built-in tools for team communication and coordination
- 🔒 **Self-Hosted** — Full data ownership with easy self-deployment options
- 🛠️ **Customizable** — Adapt workflows to match your team's processes
- 📊 **Project Tracking** — Task management with boards, lists, and timelines
- 🔔 **Notifications** — Email alerts for important updates and deadlines

## 🚀 Quick Start

### One-Click Deploy

[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/deploy/manage)

### Manual Deployment

Manage can be deployed on any platform that supports Node.js/Bun. You'll need:

```bash
# Prerequisites
- Node.js 18+
- PostgreSQL database
- S3-compatible storage (optional, for file uploads)
- SMTP server (for email notifications)
- S3-compatible storage (optional)
- SMTP server (for email)

Comment on lines +29 to +35
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Quick Start code block mixes prose with executable commands.

At Line 29 a bash fence starts, but Lines 30-35 contain markdown bullet prerequisites, not shell commands. This breaks copy/paste onboarding and can confuse users running the block as-is.

Suggested fix 
-```bash
-# Prerequisites
-- Node.js 18+
-- PostgreSQL database
-- S3-compatible storage (optional)
-- SMTP server (for email)
-
-# Clone the repository
+#### Prerequisites
+
+- Node.js 18+
+- PostgreSQL database
+- S3-compatible storage (optional)
+- SMTP server (for email)
+
+```bash
+# Clone the repository
 git clone https://github.com/techulus/manage.git
 cd manage
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
```bash
# Prerequisites
- Node.js 18+
- PostgreSQL database
- S3-compatible storage (optional, for file uploads)
- SMTP server (for email notifications)
- S3-compatible storage (optional)
- SMTP server (for email)
#### Prerequisites
- Node.js 18+
- PostgreSQL database
- S3-compatible storage (optional)
- SMTP server (for email)
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 29 - 35, The fenced block that currently begins with
```bash and contains the prerequisites bullets should be split: replace the
initial ```bash fence with a markdown heading (e.g., "#### Prerequisites") and
leave the four bullet lines as normal markdown, then open a new ```bash fenced
block only around the shell commands (the block that should contain "git clone
https://github.com/techulus/manage.git" and "cd manage"); ensure the
prerequisites bullets are not inside any code fence and that only executable
commands remain inside the bash fence.

# Clone the repository
git clone https://github.com/techulus/manage.git
cd manage

# Install dependencies
npm install

# Configure environment
cp .env.example .env
# Edit .env with your database and S3 credentials

# Run database migrations
npm run db:push

# Start the server
npm run dev
```

## 🏗️ Tech Stack

| Layer | Technology |
|-------|------------|
| Frontend | React, TypeScript |
| Backend | Node.js, Bun |
| Database | PostgreSQL |
| Storage | S3-compatible |
| Deployment | Docker, Railway |

## 📁 Project Structure

```
manage/
├── app/ # Main application code
├── public/ # Static assets
├── prisma/ # Database schema
├── .env.example # Environment template
└── package.json # Dependencies
```
Comment on lines +66 to +73
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add a language tag to the project-structure code fence.

At Line 66, the fenced block has no language identifier (MD040). Add text for lint compliance and better editor rendering.

Suggested fix 
-```
+```text
 manage/
 ├── app/              # Main application code
 ├── public/          # Static assets
 ├── prisma/          # Database schema
 ├── .env.example     # Environment template
 └── package.json     # Dependencies
</details>

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 markdownlint-cli2 (0.22.0)</summary>

[warning] 66-66: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against the current code and only fix it if needed.

In @README.md around lines 66 - 73, The fenced code block that begins with and the directory tree starting with "manage/" is missing a language identifier; update that opening fence to usetext so the block becomes ```text (i.e., add
the language tag text to the code fence that contains the manage/ directory
tree) to satisfy the MD040 lint rule and improve editor rendering.


</details>

<!-- fingerprinting:phantom:triton:hawk:52d9348e-0b78-4558-bd9b-d0e01c0b3577 -->

<!-- This is an auto-generated comment by CodeRabbit -->


## 🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## 📄 License

See `.env.example` for all required environment variables.
Licensed under the [GNU AFFERO GENERAL PUBLIC LICENSE](LICENSE).

## License
---

Licensed under the [GNU AFFERO GENERAL PUBLIC LICENSE](https://github.com/techulus/manage/blob/main/LICENSE).
README optimized with [Gingiris README Generator](https://gingiris.github.io/github-readme-generator/)