README.md

SaaS AI-based File Manager

Welcome to the SaaS AI-based File Manager project! This project combines a Python Flask backend for handling server-side logic with a React frontend for a dynamic user interface.

Demo Image

Contents

• Getting Started
  • Prerequisites
  • Setup
  • Installation
• Folder Structure
• Dependencies
• Usage
• Contributing
• Contact
• License

Getting Started

Prerequisites

Make sure you have the following installed:

• Python (with pip)
• Node.js (with npm)

Setup

1. Clone the repository:

   git clone https://github.com/UmbrellaSkiies/AI-SaaS-File-Manager.git

Installation

1. Backend:

   cd backend
   pip install -r requirements.txt
   python app.py

The Flask backend will be running at http://127.0.0.1:5000/.

2. Frontend:

   cd frontend/
   npm install
   npm start

   The React frontend will be accessible at http://localhost:5173/.

Folder Structure

AI-SaaS-File-Manager/
│
├── backend/
│   ├── static/
│   ├── templates/
│   ├── uploads/
│   ├── app.py
│   ├── requirements.txt
│   └── ... (other backend files)
│
├── frontend/
│   ├── public/
│   ├── src/
│   │   ├── components/
│   │   │   └── ... (React components)
│   │   ├── App.js
│   │   ├── index.js
│   │   └── ... (other frontend files)
│   ├── package.json
│   └── ... (other frontend configuration files)
│
├── Demo_Image/
│   └── demo.png
│
├── README.md
└── ... (other project files)

Dependencies

Backend:

• Flask: Web framework for Python.
• flask_cors: To handle CORS.
• Werkzeug: WSGI utility library.
• requests: To make HTTP requests (if needed).
• Jinja2: Templating engine for Flask.
• MarkupSafe: Provides security for Jinja2.
• python-dotenv: To load environment variables from a .env file.
• shutil: High-level file operations.

Frontend:

• React: JavaScript library for building user interfaces.
• Axios: HTTP client for making requests.

Usage

• Open your browser and visit http://localhost:5173/
• Drag and drop files onto the screen to organize them using the AI-based File Manager.

Contributing

• Fork the repository.
• Create a new branch: git checkout -b feature/new-feature.
• Commit your changes: git commit -m 'Add new feature'.
• Push to the branch: git push origin feature/new-feature.
• Submit a pull request.

Acknowledgments

Thanks to the open-source community for their contributions.

Contact

If you want to contact me you can reach me at LinkedIn or Instagram.

License

This project is free to use and does not contain any license.