diff --git a/SETUP.md b/SETUP.md new file mode 100644 index 0000000..d609fa0 --- /dev/null +++ b/SETUP.md @@ -0,0 +1,61 @@ +# Repository Setup Instructions + +## 🚀 STL Storage Application - Repository Creation + +This repository contains a complete STL file storage and 3D viewer application that needs to be pushed to https://teapot.hm.keyb.ie + +### 📋 Manual Repository Creation Steps + +Since "push to create" is not enabled on the Gitea server, please follow these steps: + +1. **Navigate to Gitea Web Interface:** + - Go to https://teapot.hm.keyb.ie + - Log in as user `kris` + +2. **Create New Repository:** + - Click "+" or "New Repository" button + - Repository name: `stl-storage` + - Description: `Web-based STL file storage and 3D viewer application` + - Visibility: Public (recommended) or Private + - **DO NOT** initialize with README, .gitignore, or license (we have these already) + +3. **Push Local Repository:** + ```bash + cd /home/kris/testing + git push -u origin main + ``` + +### 📁 Repository Contents + +- **Complete STL Storage Application** +- **Docker/Podman containerization** +- **Security hardened with rate limiting** +- **Production-ready configuration** +- **Comprehensive documentation** + +### 🔧 Ready to Deploy + +Once the repository is created and pushed, the application can be deployed using: + +```bash +# Clone and run +git clone git@teapot.hm.keyb.ie:kris/stl-storage.git +cd stl-storage +podman-compose up -d +``` + +### 📊 Application Features + +- ✅ Web-based STL upload with drag-and-drop +- ✅ Interactive 3D viewer (Three.js) +- ✅ File management and search +- ✅ SQLite database with metadata +- ✅ Security headers and rate limiting +- ✅ Containerized deployment +- ✅ Production logging and monitoring + +--- + +**SSH Key:** Already configured and authenticated +**Git Remote:** `git@teapot.hm.keyb.ie:kris/stl-storage.git` +**Local Branch:** `main` (ready to push) \ No newline at end of file