Skip to content

About

No description, website, or topics provided.

Resources

Stars

4 stars

Watchers

0 watching

Forks

Latest commit

ย 

History

65 Commits

Folders and files

Repository files navigation

Cleanytics

AI-Powered Data Cleaning & Analytics Platform


Typing Animation



GitHub Team Version






๐Ÿ“Š Turn Messy Data Into Meaningful Insights

Cleanytics is an AI-powered data cleaning and analytics platform designed to transform messy CSV and Excel datasets into clean, structured, and meaningful information.

The platform combines a modern React frontend with a FastAPI backend to provide authentication, dataset management, analytics, audit logging, health monitoring, and background job tracking.


๐Ÿ“Œ About Cleanytics

Cleanytics aims to make data cleaning and analysis easier for users who work with large or messy datasets.

๐ŸŽฏ Main Goal

Upload your data โ†’ Clean it โ†’ Analyze it โ†’ Get better insights.

Typical Workflow

User
 โ”‚
 โ–ผ
Login / Register
 โ”‚
 โ–ผ
Upload CSV / Excel
 โ”‚
 โ–ผ
Dataset Processing
 โ”‚
 โ–ผ
Data Cleaning
 โ”‚
 โ–ผ
Analytics & Quality
 โ”‚
 โ–ผ
Dashboard
 โ”‚
 โ–ผ
History / Audit / Export

โœจ Key Features

๐Ÿ”

Authentication

User registration, login, token refresh and password recovery.

๐Ÿ“

Dataset Management

Upload and manage CSV and Excel datasets.

๐Ÿ“Š

Analytics

Dashboard statistics and dataset-level analytics.

๐Ÿงน

Data Cleaning

Dataset processing and quality tracking.

๐Ÿ“

Audit History

Track user actions and application activity.

โšก

Background Jobs

Track long-running dataset processing tasks.

โค๏ธ

Health Monitoring

Monitor backend and database availability.

๐Ÿ‘ค

User Management

Manage user profiles and admin access.

๐Ÿ“ˆ

Dashboard

View dataset statistics and quality information.


๐Ÿš€ Version 2 Updates

Update Status
Dashboard โœ…
Dashboard Triggers โœ…
Dashboard Interactions โœ…
UI Improvements โœ…
Bug Fixes โœ…
Localhost Support โœ…
Frontend Integration โœ…
FastAPI Backend โœ…
API v1 Structure โœ…
Database Integration ๐Ÿ”„
Advanced Data Cleaning ๐Ÿ”„
AI Cleaning Engine ๐Ÿ”ฎ

๐Ÿ—๏ธ System Architecture

โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚          React 19 Frontend           โ”‚
โ”‚                                      โ”‚
โ”‚  Login โ€ข Dashboard โ€ข Analytics       โ”‚
โ”‚  History โ€ข Settings โ€ข Upload         โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
                   โ”‚
                   โ”‚ REST API
                   โ–ผ
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚          FastAPI Backend             โ”‚
โ”‚                                      โ”‚
โ”‚              /api/v1                 โ”‚
โ”‚                                      โ”‚
โ”‚  Auth โ€ข Users โ€ข Datasets             โ”‚
โ”‚  Analytics โ€ข Audit โ€ข Jobs โ€ข Health    โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
                   โ”‚
          โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
          โ–ผ                 โ–ผ
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”  โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚    Database     โ”‚  โ”‚ Background Jobs โ”‚
โ”‚                 โ”‚  โ”‚                 โ”‚
โ”‚ PostgreSQL      โ”‚  โ”‚ Celery          โ”‚
โ”‚ SQLite Fallback โ”‚  โ”‚ Task Tracking   โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜  โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

โš™๏ธ Backend API

The Cleanytics backend provides a versioned API layer located at:

Backend/app/api/v1/

API Modules

Backend/
โ””โ”€โ”€ app/
    โ””โ”€โ”€ api/
        โ””โ”€โ”€ v1/
            โ”œโ”€โ”€ __init__.py
            โ”œโ”€โ”€ analytics.py
            โ”œโ”€โ”€ audit.py
            โ”œโ”€โ”€ auth.py
            โ”œโ”€โ”€ datasets.py
            โ”œโ”€โ”€ health.py
            โ”œโ”€โ”€ jobs.py
            โ””โ”€โ”€ users.py

๐Ÿ” auth.py โ€” Authentication

Location:

Backend/app/api/v1/auth.py

Use

Handles user authentication and account security.

Responsibilities

  • User registration
  • User login
  • Access token generation
  • Refresh token handling
  • Password recovery
  • Password reset
  • Authentication rate limiting

Main Routes

POST /auth/register
POST /auth/login
POST /auth/refresh
POST /auth/forgot-password
POST /auth/reset-password

View auth.py


๐Ÿ“ datasets.py โ€” Dataset Management

Location:

Backend/app/api/v1/datasets.py

Use

Handles CSV and Excel dataset uploads and dataset management.

Responsibilities

  • Upload datasets
  • Process uploaded files
  • Store dataset metadata
  • Create dataset versions
  • List user datasets
  • Preview dataset information

Main Routes

POST /datasets/upload
GET  /datasets
GET  /datasets/{dataset_id}

Dataset Flow

CSV / Excel
     โ”‚
     โ–ผ
Upload API
     โ”‚
     โ–ผ
File Processing
     โ”‚
     โ–ผ
Dataset Metadata
     โ”‚
     โ–ผ
Dataset Version
     โ”‚
     โ–ผ
Database

View datasets.py


๐Ÿ“Š analytics.py โ€” Analytics

Location:

Backend/app/api/v1/analytics.py

Use

Provides dashboard and dataset-level analytics.

Responsibilities

  • Dashboard statistics
  • Dataset statistics
  • Data quality information
  • Row and column counts
  • Storage information
  • Dataset summaries

Main Routes

GET /analytics/dashboard
GET /analytics/datasets/{dataset_id}

Analytics Flow

Dataset
   โ”‚
   โ–ผ
Latest Dataset Version
   โ”‚
   โ–ผ
Data Analysis
   โ”‚
   โ”œโ”€โ”€ Rows
   โ”œโ”€โ”€ Columns
   โ”œโ”€โ”€ Quality
   โ”œโ”€โ”€ Storage
   โ””โ”€โ”€ Summary
   โ”‚
   โ–ผ
Analytics API
   โ”‚
   โ–ผ
React Dashboard

View analytics.py


๐Ÿ‘ค users.py โ€” User Management

Location:

Backend/app/api/v1/users.py

Use

Handles authenticated user profiles and admin-level user management.

Responsibilities

  • Get current user
  • Update current user
  • Validate access tokens
  • Admin authorization
  • List users

Main Routes

GET /users/me
PUT /users/me
GET /users

Authorization Flow

Access Token
     โ”‚
     โ–ผ
Token Validation
     โ”‚
     โ–ผ
Find User
     โ”‚
     โ–ผ
Authenticated User
     โ”‚
     โ”œโ”€โ”€ Normal User
     โ”‚
     โ””โ”€โ”€ Admin User

View users.py


๐Ÿ“ audit.py โ€” Audit Logs

Location:

Backend/app/api/v1/audit.py

Use

Provides audit and activity history for authenticated users.

Responsibilities

  • Retrieve audit logs
  • Track user actions
  • Track entity type
  • Track entity ID
  • Pagination support

Main Route

GET /audit/logs

Audit Flow

User Action
     โ”‚
     โ–ผ
Audit Service
     โ”‚
     โ–ผ
Audit Log
     โ”‚
     โ–ผ
GET /audit/logs
     โ”‚
     โ–ผ
History / Activity

View audit.py


โค๏ธ health.py โ€” Health Monitoring

Location:

Backend/app/api/v1/health.py

Use

Checks backend and database availability.

Main Route

GET /health

Health Flow

Health Request
      โ”‚
      โ–ผ
Database Check
      โ”‚
      โ”œโ”€โ”€ PostgreSQL
      โ”‚
      โ””โ”€โ”€ SQLite Fallback
      โ”‚
      โ–ผ
Health Status

This allows the application to determine whether the backend database connection is available.

View health.py


โšก jobs.py โ€” Background Jobs

Location:

Backend/app/api/v1/jobs.py

Use

Tracks background dataset-processing tasks.

Responsibilities

  • Track Celery tasks
  • Get task status
  • Track progress
  • Return processing messages
  • Return task results

Main Route

GET /jobs/{task_id}

Job Flow

Dataset Processing
       โ”‚
       โ–ผ
   Celery Task
       โ”‚
       โ–ผ
    Task ID
       โ”‚
       โ–ผ
GET /jobs/{task_id}
       โ”‚
       โ–ผ
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚ Status          โ”‚
โ”‚ Progress        โ”‚
โ”‚ Message         โ”‚
โ”‚ Result          โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

View jobs.py


๐Ÿงฉ API Module Overview

๐Ÿ”

auth.py



Authentication

๐Ÿ‘ค

users.py



User Management

๐Ÿ“

datasets.py



Dataset Management

๐Ÿ“Š

analytics.py



Analytics

๐Ÿ“

audit.py



Audit Logs

โค๏ธ

health.py



Health Monitoring

โšก

jobs.py



Background Jobs

๐Ÿ”—

v1



API Version


๐Ÿง  Backend Request Flow

                    React Frontend
                          โ”‚
                          โ–ผ
                   FastAPI Router
                          โ”‚
                          โ–ผ
                     /api/v1
                          โ”‚
        โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
        โ”‚                 โ”‚                 โ”‚
        โ–ผ                 โ–ผ                 โ–ผ
      Auth            Datasets          Analytics
        โ”‚                 โ”‚                 โ”‚
        โ–ผ                 โ–ผ                 โ–ผ
      Users            Services         Analysis
        โ”‚                 โ”‚                 โ”‚
        โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
                          โ”‚
                          โ–ผ
                       Database
                          โ”‚
                          โ–ผ
                  PostgreSQL / SQLite

                          โ”‚
                          โ–ผ
                     Celery Jobs
                          โ”‚
                          โ–ผ
                  Background Tasks

๐Ÿ› ๏ธ Tech Stack

๐ŸŽจ Frontend




โš™๏ธ Backend




๐Ÿ—„๏ธ Database




โšก Background Processing


๐Ÿ“Š Data Processing


๐Ÿ”ง Development Tools




๐Ÿ“ Project Structure

Cleanytics/
โ”‚
โ”œโ”€โ”€ Frontend/
โ”‚   โ””โ”€โ”€ LoginNew/
โ”‚       โ”œโ”€โ”€ src/
โ”‚       โ”‚   โ”œโ”€โ”€ components/
โ”‚       โ”‚   โ”œโ”€โ”€ screens/
โ”‚       โ”‚   โ”œโ”€โ”€ styles/
โ”‚       โ”‚   โ”œโ”€โ”€ App.jsx
โ”‚       โ”‚   โ””โ”€โ”€ main.jsx
โ”‚       โ”‚
โ”‚       โ”œโ”€โ”€ package.json
โ”‚       โ””โ”€โ”€ vite.config.js
โ”‚
โ”œโ”€โ”€ Backend/
โ”‚   โ””โ”€โ”€ app/
โ”‚       โ”œโ”€โ”€ api/
โ”‚       โ”‚   โ””โ”€โ”€ v1/
โ”‚       โ”‚       โ”œโ”€โ”€ __init__.py
โ”‚       โ”‚       โ”œโ”€โ”€ analytics.py
โ”‚       โ”‚       โ”œโ”€โ”€ audit.py
โ”‚       โ”‚       โ”œโ”€โ”€ auth.py
โ”‚       โ”‚       โ”œโ”€โ”€ datasets.py
โ”‚       โ”‚       โ”œโ”€โ”€ health.py
โ”‚       โ”‚       โ”œโ”€โ”€ jobs.py
โ”‚       โ”‚       โ””โ”€โ”€ users.py
โ”‚       โ”‚
โ”‚       โ”œโ”€โ”€ core/
โ”‚       โ”œโ”€โ”€ models/
โ”‚       โ”œโ”€โ”€ schemas/
โ”‚       โ”œโ”€โ”€ services/
โ”‚       โ””โ”€โ”€ workers/
โ”‚
โ”œโ”€โ”€ run_project.bat
โ”‚
โ””โ”€โ”€ README.md

๐Ÿ’ป How to Run

๐Ÿ˜ PostgreSQL

Start the local PostgreSQL database included with the project:

docker compose up -d postgres

Create the backend environment file from the safe local template:

Copy-Item Backend\.env.example Backend\.env

After installing the backend dependencies, apply the database migrations:

cd Backend
python -m alembic upgrade head

The local database connection is cleanytics:cleanytics@localhost:5432/cleanytics. Check that PostgreSQL is reachable at http://localhost:8000/api/v1/health after starting the backend.

โšก Frontend

cd Frontend/LoginNew
npm install
npm run dev

Open:

http://localhost:5173

โš™๏ธ Backend

cd Backend

Create virtual environment:

python -m venv .venv

Activate on Windows:

.venv\Scripts\activate

Install dependencies:

pip install -r requirements.txt

Start the FastAPI server using the project's configured backend entry point.

FastAPI documentation:

http://localhost:8000/docs

Alternative documentation:

http://localhost:8000/redoc

๐ŸชŸ Windows Quick Start

You can also start the project using:

run_project.bat

Double-click:

run_project.bat

Then open the localhost URL shown in the terminal.


๐Ÿ”— API Base Structure

/api/v1/

Main API groups:

/api/v1/auth
/api/v1/users
/api/v1/datasets
/api/v1/analytics
/api/v1/audit
/api/v1/jobs
/health

๐Ÿ” Security

Cleanytics includes authentication and authorization features such as:

  • Access tokens
  • Refresh tokens
  • Bearer authentication
  • Authenticated user validation
  • Admin authorization
  • Password reset flow
  • Authentication rate limiting
  • Dataset upload protection

๐Ÿ“Š Data Processing Flow

CSV / Excel File
       โ”‚
       โ–ผ
Dataset Upload API
       โ”‚
       โ–ผ
Upload Service
       โ”‚
       โ–ผ
Dataset Metadata
       โ”‚
       โ–ผ
Dataset Version
       โ”‚
       โ–ผ
Background Processing
       โ”‚
       โ–ผ
Data Cleaning
       โ”‚
       โ–ผ
Quality Analysis
       โ”‚
       โ–ผ
Analytics API
       โ”‚
       โ–ผ
Dashboard

๐Ÿ‘ฅ Team Members

Janmejay Kumar Singh



Janmejay Kumar Singh





Vansh Bhardwaj



Vansh Bhardwaj





Lucky Chaurasiya



Lucky Chaurasiya






๐Ÿš€ Roadmap

Phase Feature Status
01 Frontend UI โœ…
02 Dashboard โœ…
03 Dashboard Triggers โœ…
04 Authentication API โœ…
05 Dataset API โœ…
06 Analytics API โœ…
07 User API โœ…
08 Audit API โœ…
09 Health API โœ…
10 Background Jobs API โœ…
11 Advanced Cleaning Engine ๐Ÿ”„
12 AI Data Cleaning ๐Ÿ”ฎ
13 Advanced Data Quality ๐Ÿ”ฎ
14 Cloud Deployment ๐Ÿ”ฎ

๐ŸŒŸ Future Improvements

๐Ÿค– AI

  • AI-powered automatic data cleaning
  • Smart anomaly detection
  • Intelligent data quality suggestions
  • Automated data transformation
  • AI-generated dataset insights

๐Ÿ“Š Analytics

  • Advanced charts
  • Real-time analytics
  • Data quality reports
  • Custom dashboards
  • Advanced statistical analysis

๐Ÿงน Data Cleaning

  • Missing-value suggestions
  • Duplicate detection
  • Outlier detection
  • Data normalization
  • Automated column type detection

โ˜๏ธ Infrastructure

  • Cloud deployment
  • Scalable database
  • Production Redis
  • Distributed Celery workers
  • Monitoring and logging

๐Ÿ“‹ Project Information

Property Details
Project Name Cleanytics
Version 2.0
Frontend React 19 + Vite
Backend FastAPI + Python
Database PostgreSQL / SQLite
Data Processing Pandas
Background Processing Celery
API Version v1
Project Coordinator & Tester Janmejay Kumar Singh
Backend & Database Connection Vansh Bhardwaj
Frontend & Database Lucky Chaurasiya

๐Ÿ”— Important Links


๐Ÿ“ Project Status

Cleanytics is actively being developed as a complete data cleaning and analytics platform.

The project currently combines:

React Frontend
      +
FastAPI Backend
      +
Database Layer
      +
Dataset APIs
      +
Analytics APIs
      +
Authentication
      +
Audit Logs
      +
Background Jobs

The next major focus is expanding the data-cleaning engine, improving analytics, and introducing AI-powered data quality and transformation features.


Clean Data. Better Insights.


Footer Animation





Made with React โ€ข FastAPI โ€ข Python โ€ข Data

About

No description, website, or topics provided.

Resources

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages