Skip to content

Repository files navigation

🗂️ File Ninja


File Ninja is a comprehensive and user-centric open-source platform designed to manage PDF files and other digital documents efficiently. It provides advanced functionalities like file conversion, compression, splitting, merging, and AI-powered summarization.

Note

We have used postgresSQL as a database you can use any other also but postgresSQL is recommended

🎯 Objectives

  • User-Friendly Interface: Create an intuitive, accessible platform for all users.
  • Comprehensive File Manipulation: Convert, compress, split, and merge PDF files seamlessly.
  • Advanced AI Technologies: Summarize lengthy documents using AI algorithms.
  • Open-Source Commitment: Promote transparency and community-driven development.
  • Robust Security: Implement strong encryption and data protection policies.

🛠️ Requirements

  • Backend: Python, Django Framework
  • Frontend: HTML5, CSS3, JavaScript
  • Database: MongoDB or another suitable NoSQL database

📦 Prerequisites

  1. Python 3.x
    Ensure Python is installed on your system. Download from here.

  2. Node.js
    Required for managing frontend dependencies. Download from here.

  3. MongoDB
    A NoSQL database for storing data. Download from here.

🚀 Steps to Get and Install the Project

  1. Clone the Repository

    git clone https://github.com/your-username/file-ninja.git
    cd file-ninja
  2. Backend Setup

    • Create and activate a virtual environment:

      python -m venv venv
      source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
    • Install backend dependencies:

      pip install -r requirements.txt
    • Set up the database:

      python manage.py migrate
    • Run the backend server:

      python manage.py runserver
  3. Access the Application

    Open your web browser and navigate to http://localhost:8000 to access File Ninja.


Thank you for using File Ninja! We hope it simplifies your document management tasks.

About

File Ninja is an open-source platform designed to simplify the management of digital documents, with a particular focus on PDF files. It offers a suite of powerful tools that cater to various needs, from converting and compressing files to splitting, merging, and summarizing documents using advanced AI technologies.

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages