Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@ramudridhanush/autoeda) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

AutoEDA - Local Exploratory Data Analysis Platform

🔒 Data stays on your laptop. A complete EDA platform running locally with Next.js frontend and FastAPI backend.

Installation

npm install -g autoeda

Usage

Basic Usage

The simplest way to start AutoEDA:

autoeda

This uses a .env file in your current working directory.

Using a Custom `.env` File

Specify a custom path to your environment file:

autoeda --env /path/to/my.env
autoeda --env ./config/.env
autoeda --env /home/user/autoeda.env

Environment File (`.env`)

AutoEDA requires certain environment variables to run. Create a .env file with the following:

Required Variables

SECRET_KEY=your-secret-key-here
ALGORITHM=HS256
ACCESS_TOKEN_EXPIRE_MINUTES=30
DATABASE_URL=postgresql://user:password@localhost/autoeda_db
STORAGE_PATH=/path/to/data/storage
ADMIN_EMAIL=admin@example.com
ADMIN_PASSWORD=secure-password
GEMINI_API_KEY=your-gemini-api-key

Optional Variables

REDIS_URL=redis://localhost:6379
RESEND_API_KEY=your-resend-api-key
FROM_EMAIL=noreply@example.com
APP_URL=http://localhost:3000

Getting Help

autoeda --help
autoeda -h

Checking Version

autoeda --version
autoeda -v

What AutoEDA Does

Validates Environment Variables - Checks for all required variables and warns about missing optional ones
Checks Dependencies - Ensures node_modules and Python packages are installed
Starts Backend - Runs FastAPI server on http://localhost:8000
Starts Frontend - Runs Next.js development server on http://localhost:3000
Graceful Shutdown - Press Ctrl+C to cleanly stop both services

Requirements

Node.js 14.0.0 or higher
Python 3.8+ (automatically detected: python on Windows, python3 on Mac/Linux)
npm for managing frontend dependencies

Troubleshooting

"Python not found"

Make sure Python 3.8+ is installed and in your PATH:

Windows: Download from https://python.org (check "Add Python to PATH" during installation)
Mac: brew install python3
Linux: apt-get install python3 or equivalent

"Frontend dependencies not installed"

AutoEDA automatically runs npm install in the autoeda-frontend/ directory if needed.

"Backend dependencies not installed"

AutoEDA automatically runs pip install -r requirements.txt if needed.

Missing Environment Variables

Ensure your .env file includes all required variables. Run autoeda --help to see the full list.

Project Structure

.
├── bin/
│   └── autoeda.js          # CLI entry point
├── autoeda-frontend/       # Next.js application
├── autoeda-backend/        # FastAPI application
├── package.json
└── README.md

Development

To develop locally:

# Install dependencies
npm install
cd autoeda-frontend && npm install && cd ..

# Create .env file with required variables
cp autoeda-backend/.env.example .env

# Start the application
npm run dev

License

MIT

@ramudridhanush/autoeda