Signature - Digital Task Roster Application

Welcome to "Signature," a digital task roster application designed to simplify task management and enhance collaboration within teams and organizations.

Table of Contents

• Overview
• Key Features
• Getting Started
• Prerequisites
• Installation
• Usage
• Technology Stack
• Contributing
• License

Overview

"Signature" is a web-based task management application that offers the following key features:

• Task creation and assignment.
• Real-time updates for collaborative task management.
• Optional payday calculation for earnings based on completed tasks.
• User authentication and data security.
• User profile management.
• Notifications and reminders.

Key Features

• Task Management: Create, assign, and track tasks efficiently within your team or organization.

• Real-Time Updates: Experience real-time task updates to keep everyone on the same page.

• Payday Calculation: An optional feature that simplifies earnings calculation for completed tasks.

• Authentication: Secure user authentication using Firebase Authentication.

• User Profiles: Manage your user profile, including name and email.

• Notifications: Receive automated notifications and reminders for task assignments and deadlines.

Getting Started

Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js and npm installed on your development environment.

Installation

1. Clone the repository:

git clone https://github.com/sammiearchie77/signature.git

2. Install dependencies for both the frontend and backend:

cd signature
yarn install

3. Configure your environment variables. You can use .env.example files as templates.

4. Start the development servers:

yarn run development

5. Open your web browser and access the application at http://localhost:3000.

Usage

• Sign up for a new account or log in with your existing credentials.
• Create and assign tasks to team members.
• Experience real-time updates as tasks are added, completed, or modified.
• Utilize the payday calculation feature for earnings tracking.
• Customize your profile settings and notification preferences.

Technology Stack

• Frontend: React.js, Material-UI
• Backend: Node.js, Express.js, MongoDB
• Authentication: Firebase Authentication
• Real-Time Updates: Socket.io

Contributing

We welcome contributions from the community. Feel free to submit bug reports, feature requests, or pull requests to help improve "Signature."

License This project is licensed under the MIT License - see the LICENSE file for details.