diff --git a/.gitignore b/.gitignore index ab82218..b577eb5 100644 --- a/.gitignore +++ b/.gitignore @@ -74,4 +74,6 @@ bin/ # Proje özel (gerektiğinde ekleyin) # .next/ # .expo/ -# .vercel/ \ No newline at end of file +# .vercel/ + +.claude/ \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..1b49063 --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +# AlgorithmicWing + +A Python tool for designing aircraft with code. Generate 3D aircraft models (wings, fuselage, windows) programmatically and export them for 3D printing or analysis. + +## What It Does + +- **Generate aircraft components** using mathematical parameters +- **Create wings** with NACA airfoil profiles +- **Design fuselages** with customizable shapes +- **Add windows** with realistic frames +- **Export to STL** for 3D printing or CFD analysis + +## Quick Start + +### Installation + +```bash +git clone +cd algorithmicWing + +# Create virtual environment +python -m venv .venv + +# Activate virtual environment +# Windows: +.venv\Scripts\activate +# Linux/Mac: +source .venv/bin/activate + +# Install dependencies +pip install fastapi uvicorn numpy +``` + +### Run the Application + +**1. Start the Backend (Python/FastAPI):** +```bash +# Make sure virtual environment is activated first +uvicorn main:app --reload +``` + +**2. Open the Frontend (Web Interface):** +- local server: `python -m http.server 8001` then visit `http://localhost:8001/frontend/` + +The 3D visualization will load and display the aircraft model with: +- Interactive 3D view (rotate, zoom, pan) +- Real-time aircraft generation +- Wing, fuselage, and window components + +### View the API + +You can also access the API directly: +- `http://localhost:8000/generate-wing` - Returns aircraft geometry as JSON +- `http://localhost:8000/docs` - Interactive API documentation (Swagger UI) + + +## Dependencies + +- FastAPI - Web server +- NumPy - Math operations +- Uvicorn - ASGI server + +## License + +Open source. Check repository for details. \ No newline at end of file