Skip to content

Saroj05Dev/TaskForge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

65 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸš€ TaskForge

A Modern Collaborative Task Management Platform

Version License PRs Welcome React Vite

Features β€’ Demo β€’ Tech Stack β€’ Getting Started β€’ Usage β€’ Contributing


πŸ“‹ About The Project

TaskForge is a powerful, real-time collaborative task management platform designed to streamline team workflows and boost productivity. Built with modern web technologies, it offers an intuitive interface for managing tasks, teams, and projects with real-time updates powered by Socket.IO.

✨ Why TaskForge?

  • Real-time Collaboration: See changes instantly as your team works together
  • Intuitive Interface: Clean, modern UI built with React and TailwindCSS
  • Team Management: Organize teams, assign tasks, and track progress effortlessly
  • Activity Tracking: Keep track of all changes and updates in real-time
  • Drag & Drop: Intuitive task organization with drag-and-drop functionality
  • Responsive Design: Works seamlessly across desktop, tablet, and mobile devices

🎯 Features

Core Features

  • βœ… Task Management

    • Create, update, and delete tasks
    • Assign tasks to team members via email or user ID
    • Set priorities, due dates, and status
    • Add subtasks and track progress
    • Attach files and documents
    • Add comments and collaborate
  • πŸ‘₯ Team Collaboration

    • Create and manage teams
    • Invite members via email
    • Role-based access control
    • Real-time team activity feed
  • πŸ”„ Real-time Updates

    • Live task updates across all connected clients
    • Real-time notifications
    • Socket.IO powered synchronization
    • Instant activity feed updates
  • 🎨 User Experience

    • Drag-and-drop task organization
    • Beautiful, responsive UI
    • Dark mode support (if implemented)
    • Smooth animations and transitions
    • Intuitive navigation
  • πŸ” Authentication & Security

    • Secure user authentication
    • Protected routes
    • Session management
    • User profile management

πŸ› οΈ Tech Stack

Frontend

Backend

  • API: RESTful API with Socket.IO integration
  • Real-time: Socket.IO for live updates
  • Authentication: JWT-based authentication

Development Tools

  • Linting: ESLint with React plugins
  • Code Quality: React Hooks linting
  • Version Control: Git
  • Deployment: Netlify (configured)

πŸš€ Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (v16 or higher)
  • npm or yarn
  • Git

Installation

  1. Clone the repository

    git clone https://github.com/Saroj05Dev/TaskForge.git
    cd TaskForge
  2. Install dependencies

    npm install
    # or
    yarn install
  3. Set up environment variables

    Create a .env file in the root directory:

    VITE_API_BASE_URL=your_backend_api_url
  4. Start the development server

    npm run dev
    # or
    yarn dev
  5. Open your browser

    Navigate to http://localhost:5173 (or the port shown in your terminal)


πŸ“– Usage

Running the Application

# Development mode with hot reload
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview

# Run linter
npm run lint

Project Structure

TaskForge/
β”œβ”€β”€ public/              # Static assets
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ assets/          # Images, fonts, etc.
β”‚   β”œβ”€β”€ components/      # Reusable UI components
β”‚   β”œβ”€β”€ contexts/        # React context providers
β”‚   β”œβ”€β”€ features/        # Feature-based modules
β”‚   β”‚   β”œβ”€β”€ activity/    # Activity tracking
β”‚   β”‚   β”œβ”€β”€ auth/        # Authentication
β”‚   β”‚   β”œβ”€β”€ tasks/       # Task management
β”‚   β”‚   └── teams/       # Team management
β”‚   β”œβ”€β”€ helpers/         # Helper functions
β”‚   β”œβ”€β”€ hooks/           # Custom React hooks
β”‚   β”œβ”€β”€ layouts/         # Layout components
β”‚   β”œβ”€β”€ pages/           # Page components
β”‚   β”œβ”€β”€ routes/          # Route configurations
β”‚   β”œβ”€β”€ store/           # Redux store setup
β”‚   β”œβ”€β”€ utils/           # Utility functions
β”‚   β”œβ”€β”€ App.jsx          # Main App component
β”‚   └── main.jsx         # Entry point
β”œβ”€β”€ .env                 # Environment variables
β”œβ”€β”€ index.html           # HTML template
β”œβ”€β”€ package.json         # Dependencies
β”œβ”€β”€ vite.config.js       # Vite configuration
└── README.md            # This file

Key Features Usage

Creating a Task

  1. Navigate to the Tasks page
  2. Click "Create Task" button
  3. Fill in task details (title, description, assignee, priority, due date)
  4. Click "Save" to create the task

Managing Teams

  1. Go to Teams section
  2. Create a new team or select an existing one
  3. Invite members via email
  4. Assign tasks to team members

Real-time Collaboration

  • All changes are automatically synced across all connected clients
  • Activity feed shows real-time updates
  • Notifications appear for important events

πŸ“Έ Screenshots

Dashboard Task Page Task Details Page Action Log Page


🀝 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.

How to Contribute

  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

Development Guidelines

  • Follow the existing code style
  • Write meaningful commit messages
  • Add comments for complex logic
  • Test your changes thoroughly
  • Update documentation as needed

πŸ“„ License

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


πŸ‘¨β€πŸ’» Author

Saroj Kumar Das


πŸ™ Acknowledgments


πŸ“ž Support

If you have any questions or need help, feel free to:

  • Open an issue on GitHub
  • Contact me via email
  • Join our community discussions

Made with ❀️ by Saroj Kumar Das

⭐ Star this repository if you find it helpful!

About

A collaborative task platform.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages