Taskflow

Introduction

Taskflow is a powerful application designed to help individuals and teams stay organized, efficient, and productive.

Table of Contents

• Taskflow
  • Introduction
  • Table of Contents
  • Features
  • Getting Started
  • System Architecture
    • Frontend
    • Backend
    • Database
    • Deployment and Hosting
  • Database Schema
    • Authentication Schema:
    • Application Schema:
  • Contributing
  • Code of Conduct
  • License

Features

Our platform offers a range of unique features and benefits, including:

• Workspaces : Taskflow allows you to create multiple workspaces, each with its own set of tasks and team members. This feature allows you to keep different projects separate and organized.

• Drag and Drop : With Taskflow, you can easily drag and drop tasks between lists and boards, making it easy to prioritize and reorganize your tasks.

• Team Members : You can easily invite team members to join your workspace, allowing them to collaborate with you on tasks and projects.

• Member Roles: Taskflow offers a range of member roles, from admin to viewer, allowing you to control who has access to what information.

• Custom Board Background: You can customize your workspace by adding a custom board background, making your workspace more personalized and enjoyable to work in.

Getting Started

To run the application locally or deploy it, follow these general steps mentioned in Setup Instructions

System Architecture

The system architecture of taskflow leverages a combination of cutting-edge technologies to ensure reliability, scalability, and efficiency.

Frontend

• Next.js v12: Taskflow's frontend is built using Next.js, a React framework for web applications. Next.js provides server-side rendering, which enhances performance and SEO.

• Tailwind CSS: The utility-first CSS framework, Tailwind CSS, is used for designing and styling the user interface. It offers flexibility and customization for a polished design.

• shadnUi: Taskflow incorporates complex UI components from shadnUi, enhancing the user interface with sophisticated and user-friendly elements.

Backend

• tRPC: Taskflow employs tRPC, a fast TypeScript RPC framework, to build APIs. This ensures efficient communication between the frontend and backend, enabling dynamic interactions.

• Prisma: Prisma serves as the type-safe ORM (Object-Relational Mapping) for TypeScript and Node.js, allowing efficient data management and retrieval.

• Nextauth: Nextauth is an open-source authentication solution for Next.js applications, ensuring secure user authentication and authorization.

Database

• Neon: Neon is a serverless Postgres database used for storing and retrieving data. It provides a scalable and reliable data storage solution.

Deployment and Hosting

• Vercel: Taskflow leverages Vercel, a cloud platform for deploying and managing web applications. Vercel offers scalability and a straightforward deployment process, ensuring a smooth user experience.

This technology stack, combined with a well-designed architecture, enables Taskflow to deliver a performant and user-friendly task management platform.

Database Schema

In Taskflow, the database schema is designed to support various features of the application, including user management, workspaces, tasks, boards, and more. Below is an overview of the key database models and their relationships.

Authentication Schema:

• User:

  • Represents system users with fields like id, name, email, image, and password.
  • Linked to tasks, workspaces, and invitations.

• Account:

  • Represents external authentication accounts linked to users.
  • Fields include id, userId, type, and provider.

• Session:

  • Represents user sessions with fields like id, sessionToken, userId, and expires.

• VerificationToken and ResetPasswordToken:

  • Used for email verification and password reset, storing token information.

• Passkey:

  • Represents passkeys for authentication with fields like id, name, userId, counter, and transports.

Application Schema:

• Workspace:

  • Represents Taskflow workspaces with fields like id, createdAt, name, and personal.
  • Associated with boards and members.

• WorkspaceMember:

  • Represents members within a workspace with fields like id, userId, role, and memberSince.
  • Linked to a user and workspace.

• WorkspaceMemberInvitation:

  • Represents workspace invitations with fields like id, recipient, recipientEmail, sender, and role.
  • Associated with a workspace.

• Board:

  • Represents boards within a workspace with fields like id, createdAt, updatedAt, name, and description.
  • Linked to lists and a workspace.

• List:

  • Represents lists within a board with fields like id, createdAt, name, and boardId.
  • Associated with tasks and a board.

• Task:

  • Represents tasks within a list with fields like id, createdAt, title, description, listId, and rank.
  • Associated with members and a list.

• TaskMember:

  • Represents members assigned to a task with fields like id, createdAt, taskId, and userId.
  • Linked to a task and a user.

The database schema is designed to support the collaborative and organizational features of Taskflow, allowing users to manage tasks, workspaces, and more effectively.

Contributing

Contributions to this project are welcome. Please follow the Contribution Guidelines when making changes.

Code of Conduct

Please review our Code of Conduct to understand the behavior we expect from all contributors and users of this project.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.