Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/khalidkhankakar/fire-grid

FireGrid is task management and collaboration tool inspired by Trello. It offers an intuitive Kanban board interface for organizing and tracking tasks eed and scalability, FireGrid leverages the latest features of Next.js 15 RC efficiently.
https://github.com/khalidkhankakar/fire-grid

css docker drizzle-orm honojs html javascript liveblocks nextjs postgresql reactjs sentry shadcn-ui tailwindcss tanstack-react-query typescript

Last synced: 6 days ago
JSON representation

FireGrid is task management and collaboration tool inspired by Trello. It offers an intuitive Kanban board interface for organizing and tracking tasks eed and scalability, FireGrid leverages the latest features of Next.js 15 RC efficiently.

Awesome Lists containing this project

README

        

# FireGrid ๐Ÿ”ฅ๐Ÿ“‹
**A Real-Time Collaborative Task Management App**

FireGrid is a powerful, real-time task management application designed for both personal use and team collaboration. With seamless drag-and-drop functionality, advanced fuzzy search, customizable task cards, and dynamic filters, managing your tasks has never been easier!

---

## ๐Ÿ”‘ **Key Features**

### 1. **Real-Time Task Management**
- **Collaborate effortlessly**: Updates on tasks are instantly synced across all devices.
- Work on shared boards with your team or manage personal boards.

### 2. **FireGrid AI Assistance**
- Integrated **FireGrid AI Bot** to assist you if you're stuck while using the app.
- Get step-by-step guidance and suggestions from the AI directly in the app.

### 3. **Board Forking**
- Fork other users' board templates by simply clicking the **Fork** button.
- Create a copy and make it your own instantly.

### 4. **Real-Time Cursor Presence**
- See other users' cursors in real time when working on the same board or organization.
- Enhanced collaboration with visual feedback of who is editing what.

### 5. **Customizable Task Cards and Tables**
- Change colors to categorize tasks (e.g., priority levels, task types).
- Add tags, due dates, and other metadata to keep everything organized.

### 6. **Seamless Drag-and-Drop Functionality**
- Intuitive drag-and-drop to rearrange tasks.
- Move tasks between columns or boards with ease.

### 7. **Advanced Fuzzy Search**
- Quickly locate tasks using keywords, even with typos or partial matches.
- Search across all boards and its categories.

### 8. **Filters boards**
- Filter boards by:
- Order (asc, desc).
- Dates.
- Categories.

### 9. **Seamless Login with Clerk Auth System**
- Log in effortlessly using GitHub, Google, or email authentication powered by Clerk.

### 10. **Favoriting Boards**
- Favorite and unfavorite boards to quickly access the ones that matter most.
### 11. **Light and Dark Theme**
- Switch between light and dark modes to suit your preference and reduce eye strain.

---

## ๐Ÿš€ **Tech Stack**

- **Frameworks and Libraries**: Next.js, React.js, ShadCN UI Component Library, Tailwind CSS.
- **Real-Time Collaboration**: Liveblocks for real-time presence and collaboration.
- **Backend**: Hono for APIs, Vercel AI for AI integrations.
- **AI Bot**: LangChain and Gemini, integrated with Datastax for efficient query processing.
- **Database**: Neon PostgreSQL with Drizzle ORM for structured and scalable data management.
- **State Management**: TanStack Query for efficient data fetching and caching.
- **DevOps and Monitoring**: Docker for containerization, Sentry for error tracking.
- **Deployment**: Vercel for seamless CI/CD and hosting.

---

## ๐Ÿ“‚ **Modules**

### 1. **Personal Task Boards**
- Create boards for personal goals and daily task management.

### 2. **Team Collaboration**
- Invite team members to collaborate on boards.
- Assign tasks to specific members and track progress.

### 3. **Customization**
- Change board themes and colors to suit your style.
- Organize columns based on workflows like Kanban (e.g., To-Do, In Progress, Done).

---

## ๐ŸŒŸ **Future Enhancements**

- **Notifications**: Get real-time notifications for task updates.
- **Analytics**: Insights into task progress, team productivity, and deadlines.
- **Integrations**: Connect with tools like Google Calendar, Slack, and Trello.
- **Stripe**: Implementing the stripe to pay bills of FireGrid.

---

## ๐Ÿ› ๏ธ **Installation**

Follow these steps to install and set up FireGrid:

### 1. **Prerequisites**
Ensure you have the following installed on your system:
- [Node.js](https://nodejs.org/) (v18 or later)
- [Docker](https://www.docker.com/) (if using containerized deployment)
- [Git](https://git-scm.com/) (to clone the repository)
- A database instance (e.g., [Neon PostgreSQL](https://neon.tech/))
- Optional: [Vercel CLI](https://vercel.com/) for deployment on Vercel.

---
Follow these steps to run the project locally:

1. **Clone the Repository**:
```bash
git clone https://github.com/khalidkhankakar/Fire-Grid.git
cd fire-grid
```
2. **Setup the Enviroment key**:
```bash
# Postgress database key
# https://neon.tech/
POSTGRES_URL=postgresql://neondb_owner:***********************

# Clerk Env Keys
# https://clerk.com/
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_****************
WEBHOOK_SECRET=*********************
NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
CLERK_SECRET_KEY=sk_test_ynGfbMyuNwmP3OV3pSEgvV9EQynQgJgyBdmFt9H34j

# https://sentry.io/welcome/
SENTRY_AUTH_TOKEN=****

# https://aistudio.google.com/app/apikey
GOOGLE_API_KEY=*****

# https://www.datastax.com/
ASTRA_DB_APPLICATION_TOKEN=******
ASTRA_DB_API_ENDPOINT=*****
ASTRA_DB_NAMESPACE=*****

# Also add your own liveblocks key and project
# https://liveblocks.io/

```
3. **Install Dependencies**:
```bash
npm install --force
or
pnpm install
```
4. **Run the Development Server**:
```bash
npm run dev
or
pnpm run dev

```

---

## ๐Ÿ“š **Resources**

Learn more about the technologies and tools used to build FireGrid:

### Frontend
- [Next.js](https://nextjs.org/) โ€“ React-based framework for building server-rendered apps.
- [React.js](https://reactjs.org/) โ€“ A JavaScript library for building user interfaces.
- [Tailwind CSS](https://tailwindcss.com/) โ€“ Utility-first CSS framework for styling.
- [ShadCN UI](https://ui.shadcn.com/) โ€“ Component library for building modern UI designs.

### Real-Time Collaboration
- [Liveblocks](https://liveblocks.io/) โ€“ Real-time presence and collaboration for web apps.

### Backend
- [Hono](https://hono.dev/) โ€“ Ultrafast web framework for building APIs.
- [Vercel AI SDK](https://sdk.vercel.ai/) โ€“ Toolkit for integrating AI models into apps.

### State Management and Fetching
- [TanStack Query](https://tanstack.com/query/v4) โ€“ Powerful data-fetching library for React.

### Database
- [Neon](https://neon.tech/) โ€“ Serverless PostgreSQL platform.
- [Drizzle ORM](https://orm.drizzle.team/) โ€“ TypeScript ORM for type-safe SQL queries.

### AI and Machine Learning
- [LangChain](https://www.langchain.com/) โ€“ Framework for building AI-powered applications.
- [Gemini AI](https://ai.google.dev/) โ€“ Advanced AI language models by Google.
- [Datastax](https://www.datastax.com/) โ€“ NoSQL database and tools for AI applications.

### DevOps and Monitoring
- [Docker](https://www.docker.com/) โ€“ Containerization platform for scalable deployments.
- [Sentry](https://sentry.io/) โ€“ Application monitoring and error tracking.

### Authentication
- [Clerk](https://clerk.dev/) โ€“ Authentication service with social login support.

### Deployment
- [Vercel](https://vercel.com/) โ€“ Hosting platform for web applications.

These resources will help you understand the stack powering FireGrid and guide you in extending its functionality!

---
## ๐ŸŽฏ **Why Choose FireGrid?**

Whether you're a solo professional or managing a large team, FireGrid empowers you to stay organized, productive, and connected. Experience task management that's:
- **Efficient**: Real-time updates mean no more delays.
- **Flexible**: Customize workflows and collaborate your way.
- **Powerful**: AI integration, search, and filter tools to find exactly what you need.

---
## ๐Ÿค Contribution Guidelines
We welcome contributions! Follow these steps:

1. Fork the repository ๐Ÿด
2. Create a new branch: git checkout -b feature-name ๐ŸŒฟ
3. Commit changes: git commit -m "Add new feature" ๐Ÿ“
4. Push to branch: git push origin feature-name ๐Ÿš€
5. Submit a pull request ๐Ÿ”„

## ๐Ÿ‘ฉโ€๐Ÿ’ป Authors
[khalidkhankakar](https://github.com/khalidkhankakar/) ๐Ÿ’ป

## ๐ŸŒ Connect With Us
๐Ÿ’ฌ Have questions or feedback? Open an issue.
โญ Enjoyed the project? Give us a star!

## ๐Ÿ“Œ Note
This project is under active development. Stay tuned for updates! ๐Ÿšงโœจ

I have created **FireGrid** specifically for the **JavaScript Mastery Hackathon** as a showcase of real-time collaborative task management capabilities. It demonstrates advanced features like AI integration, real-time collaboration, and seamless user experiences tailored for productivity apps.