nextpy-cli 1.1.1

CLI tool to scaffold FastAPI + Next.js full-stack applications with Fox AI companion

NextPy CLI

Scaffold full-stack FastAPI + Next.js applications in seconds

NextPy is a powerful CLI tool that helps you quickly scaffold modern full-stack applications with FastAPI backend and Next.js frontend, complete with Docker support and multiple database options.

🚀 Quick Start

Recommended: Using uvx (Fastest)

No installation required! Run directly:

uvx nextpy-cli my-awesome-app

Alternative Methods

# Using pip
pip install nextpy-cli
nextpy my-awesome-app

# Using uv (faster pip)
uv pip install nextpy-cli
nextpy my-awesome-app

# Using pipx (isolated environment)
pipx install nextpy-cli
nextpy my-awesome-app

✨ Features

• 🦊 Fox - Your Smart Dev Companion - Intelligent CLI mascot that remembers your preferences and provides contextual suggestions
• FastAPI Backend - Modern, fast Python web framework
• Next.js Frontend - React framework with TypeScript support
• Multiple Database Options - PostgreSQL, MongoDB, or SQLite
• Docker Ready - Complete Docker and Docker Compose setup
• TypeScript - Full TypeScript support for type safety
• Vite - Lightning-fast development with Vite
• Interactive CLI - Beautiful, user-friendly prompts powered by Rich and Questionary
• Smart Suggestions - Fox learns your preferences and suggests your usual stack
• Best Practices - Production-ready project structure

📦 What You Get

Backend (FastAPI)

• RESTful API structure
• Database integration (PostgreSQL/MongoDB/SQLite)
• Environment configuration
• CORS setup
• Health check endpoints
• Docker configuration

Frontend (Next.js)

• TypeScript configuration
• Vite for fast development
• API client setup
• Modern React patterns
• Responsive design ready
• Docker configuration

DevOps

• Docker Compose for local development
• Separate Dockerfiles for frontend and backend
• Environment variable management
• Production-ready configurations

🎯 Usage

Create a New Project

# Quick start with uvx (recommended)
uvx nextpy-cli my-project

# Or if installed
nextpy my-project

The CLI will guide you through:

1. Project name
2. Frontend framework (Next.js or Vite + React)
3. Database choice (SQLite, PostgreSQL, or MongoDB)
4. Docker support (yes/no)
5. GitHub repository initialization (yes/no)
6. Automatic setup and installation

Start Development

cd my-project

# Start with Docker Compose (recommended)
docker-compose up

# Or start services individually:

# Backend
cd backend
pip install -r requirements.txt
uvicorn main:app --reload

# Frontend
cd frontend
npm install
npm run dev

🌐 Access Your Application

• Frontend: http://localhost:3000
• Backend API: http://localhost:8000
• API Docs: http://localhost:8000/docs

🦊 Meet Fox - Your Smart Dev Companion

Fox is NextPy's intelligent CLI mascot that makes project creation delightful and efficient!

What Fox Does:

• Remembers Your Preferences - "You usually go with Next.js + PostgreSQL. Use that again?"
• Smart Suggestions - Recommends the right database for your project type
• Celebrates Milestones - Special messages for your 1st, 5th, 10th, 25th, and 50th projects!
• Contextual Tips - Provides relevant advice based on your choices
• Personality Modes - Choose how chatty Fox should be

Fox Modes:

# Verbose - Maximum personality, tips, and commentary
nextpy my-project --fox-mode verbose

# Normal - Balanced helpfulness (default)
nextpy my-project --fox-mode normal

# Quiet - Essential messages only
nextpy my-project --fox-mode quiet

# Silent - No Fox messages
nextpy my-project --fox-mode silent

# Set globally with environment variable
export NEXTPY_FOX_MODE=verbose
nextpy my-project

Quick Commands:

# Use your last configuration
nextpy my-new-project --last

# Combine options
nextpy my-project --fox-mode verbose --last

Fox Features:

• 🧠 Smart Memory - Tracks your preferences across projects (stored in ~/.nextpy/preferences.json)
• 💡 Context-Aware - Detects project types (e-commerce, blog, API, etc.)
• 🎯 Intelligent Recommendations - Suggests appropriate tech stacks
• 🎉 Milestone Celebrations - Acknowledges your progress
• 🎨 Personality - Witty, dev-focused messages

📋 Requirements

• Python 3.11 or higher
• Node.js 18+ (for the generated frontend)
• Docker (optional, but recommended)

🛠️ Project Structure

my-project/
├── backend/
│   ├── main.py              # FastAPI application
│   ├── requirements.txt     # Python dependencies
│   ├── .env                 # Environment variables
│   └── Dockerfile
├── frontend/
│   ├── src/
│   │   ├── pages/          # Next.js pages
│   │   ├── components/     # React components
│   │   └── lib/            # Utilities
│   ├── package.json
│   └── Dockerfile
├── docker-compose.yml       # Docker orchestration
└── README.md               # Project documentation

🔧 Installation

Using uvx (Recommended - No Installation)

Run directly without installing:

uvx nextpy-cli my-project

Advantages:

• ⚡ 10-100x faster than pip
• ✅ No installation needed
• ✅ Isolated environment
• ✅ Always latest version

From PyPI

# Using pip
pip install nextpy-cli

# Using uv (faster)
uv pip install nextpy-cli

# Using pipx (isolated)
pipx install nextpy-cli

From Source

git clone https://github.com/VesperAkshay/nextpy.git
cd nextpy/python-cli
pip install -e .

Installing uv/uvx

If you don't have uv installed:

# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

# Or with pip
pip install uv

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

MIT License - see the LICENSE file for details.

🔗 Links

• GitHub Repository
• Report Issues
• PyPI Package
• npm Package

💡 Why NextPy?

• Save Time: Skip the boilerplate and start building features immediately
• Best Practices: Pre-configured with industry standards
• Flexible: Choose your database and customize as needed
• Modern Stack: Use the latest and greatest technologies
• Docker Ready: Deploy anywhere with confidence
• Python-First: Built by Python developers, for Python developers

🐛 Troubleshooting

Command not found after installation

Make sure your Python scripts directory is in your PATH:

# On Linux/Mac
export PATH="$HOME/.local/bin:$PATH"

# On Windows
# Add %APPDATA%\Python\Python311\Scripts to your PATH

Permission errors on Linux/Mac

pip install --user nextpy-cli

📚 Documentation

For more detailed documentation, visit our GitHub repository.

---

Made with ❤️ by VesperAkshay