Giter VIP home page Giter VIP logo

pdf-tracker's Introduction

PDF Tracker

PDF Tracker is a web application designed to manage and track collections of PDFs for projects. It allows you to organize PDFs, track readership, and control access to specific collections.

Features

  • PDF Management: Upload, organize, and manage PDF files for your projects.
  • Reader Tracking: Keep track of who has viewed or accessed specific PDFs.
  • Access Control: Control access to collections, ensuring only authorized users can view or manage them.
  • User Authentication: Secure user authentication to manage user accounts and permissions.

Getting Started

Follow these steps to set up and run the PDF Tracker locally on your machine.

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/pdf-tracker.git
  2. Navigate to the project directory:

    cd pdf-tracker
  3. Install dependencies:

    npm install
  4. Create a Firebase project and set up authentication and Firestore database.

  5. Create a .env file in the project root and add your Firebase configuration:

    VITE_FIREBASE_API_KEY=your-api-key
    VITE_FIREBASE_AUTH_DOMAIN=your-auth-domain
    VITE_FIREBASE_PROJECT_ID=your-project-id
    VITE_FIREBASE_STORAGE_BUCKET=your-storage-bucket
    VITE_FIREBASE_MESSAGING_SENDER_ID=your-messaging-sender-id
    VITE_FIREBASE_APP_ID=your-app-id
    
  6. Start the application:

    npm run dev
  7. Open http://localhost:5173 in your browser.

Firebase CORS Issue

If you encounter CORS issues with Firebase, you can follow this guide to resolve them through Google Cloud Console.

Usage

  • Login: Log in with your credentials or create a new account.
  • Upload PDFs: Add PDF files to your project collections.
  • Manage Collections: Create, edit, or delete collections.
  • Track Readers: View the history of users who accessed specific PDFs.
  • Access Control: Set permissions for users to control who can access specific collections.

Acknowledgments

  • Thanks to Firebase for providing storage and database services.
  • Special thanks to react-pdf-viewer for providing a fantastic PDF viewer component, which greatly contributes to the functionality of this project.

pdf-tracker's People

Contributors

ramchandrawarang9822 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.