Skip to content

Latest commit

 

History

History
93 lines (62 loc) · 3.44 KB

README.md

File metadata and controls

93 lines (62 loc) · 3.44 KB

Productivity Pulse

JavaScript Tailwind CSS React Node.js Firebase

A productivity tool designed for project teams to streamline workflows, enhance collaboration, and maximize efficiency.

Features

  • Real-time task management and tracking
  • Team chat and collaboration
  • Member management with role-based permissions
  • Analytics and reporting
  • Invitation management with email notifications

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What you need to install the software:

  • Node.js (Version 14 or higher)
  • npm (Node Package Manager)
  • A Firebase project with Firestore and Authentication enabled

Installing

A step-by-step series of examples that tell you how to get a development environment running:

  1. Clone the repository:

    git clone https://github.com/aditya-shrey/productivity-pulse.git

  2. Navigate to the project repository:

    cd productivity-pulse

  3. Install the project dependencies:

    npm install

  4. Set up your Firebase project and get your Firebase configuration. Create a .env file in the root directory and add your Firebase configuration:

    REACT_APP_FIREBASE_API_KEY=your_api_key
REACT_APP_FIREBASE_AUTH_DOMAIN=your_auth_domain
REACT_APP_FIREBASE_PROJECT_ID=your_project_id
REACT_APP_FIREBASE_STORAGE_BUCKET=your_storage_bucket
REACT_APP_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_id
REACT_APP_FIREBASE_APP_ID=your_app_id

  5. Start the development server:

    npm start

    Your application should now be running on http://localhost:3000.

Deploying

Since the deployment process is specific to your environment, ensure to follow your internal guidelines for deploying React applications.

Built With

  • JavaScript - Primary programming language
  • Tailwind CSS - Utility-first CSS framework
  • React - Frontend library
  • Node.js - JavaScript runtime
  • Firebase - Backend services (Authentication, Firestore, etc.)

Contributing

Contributions to this project are welcome. If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

License

This project is licensed under the MIT License. Feel free to use and modify the code as per the license terms.