Ensure you have the following installed on your system:
- Git (for cloning the repository)
- Node.js (v18 or higher)
- Python (v3.12 or higher)
- Astral UV: The extremely fast Python package and project manager.
- Install UV: https://github.com/astral-sh/uv
- Quick Install (Unix):
curl -LsSf https://astral.sh/uv/install.sh | sh - Quick Install (Windows):
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
git clone <your-repository-url>
cd baseprogramWe use UV for lighting-fast dependency resolution and environment management.
cd backend
# Install dependencies and create a virtual environment
uv sync
# Configure Environment Variables
# Create a .env file based on the provided template if available
# Example: cp .env.example .env (or manually create one)Run the Backend:
uv run uvicorn app.main:app --reload- API Documentation: http://localhost:8000/docs
- Health Check: http://localhost:8000/
The frontend uses React with modern npm practices.
cd ../frontend
# Install dependencies using the standard npm workflow
npm install
# Run the Development Server
npm start- Local Application: http://localhost:3000
baseprogram/
├── backend/ # FastAPI Application
│ ├── app/ # Core logic, routers, and models
│ ├── pyproject.toml # UV project configuration
│ └── uv.lock # Locked dependencies
├── frontend/ # React Application
│ ├── src/ # Components, pages, and assets
│ ├── public/ # Static assets
│ └── package.json # Node.js dependencies and scripts
└── README.md # You are here!
- ✅ FastAPI: Asynchronous, high-performance web framework.
- ✅ Astral UV: modern replacement for
pipandvirtualenv. - ✅ JWT Auth: Secure authentication flow with Python-Jose.
- ✅ Tailwind CSS: Modern utility-first CSS framework for rapid styling.
- ✅ Modern NPM: Clean, local-first dependency management (no global tools required).
This project is licensed under the MIT License.