From c1a2bc174f81abd86dc1327f92209b5b43eff84d Mon Sep 17 00:00:00 2001 From: Mathis Kirchner Date: Thu, 18 Dec 2025 17:16:37 +0000 Subject: [PATCH] Add docs and gitignore --- .gitignore | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 86 insertions(+) create mode 100644 .gitignore create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..25dff95 --- /dev/null +++ b/.gitignore @@ -0,0 +1,49 @@ +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +pnpm-debug.log* +lerna-debug.log* + +# Diagnostic reports +report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Coverage directory +coverage +*.lcov +.nyc_output + +# Dependency directories +node_modules/ +jspm_packages/ + +# TypeScript cache +*.tsbuildinfo + +# Optional npm cache directory +.npm +.eslintcache + +# dotenv environment variables file +.env +.env.test +.env.production +.env.local + +# Vite Output +dist/ + +# OS Files +.DS_Store +Thumbs.db + +# Docker +docker-compose.override.yml diff --git a/README.md b/README.md new file mode 100644 index 0000000..c82b08a --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# Liquid Development Website + +The official portfolio website for **Liquid Development**, a German development team. +Designed with a modern "Liquid" aesthetic using dark mode, glassmorphism, and fluid animations. + +## 🚀 Tech Stack + +- **Core:** [React](https://react.dev/) + [Vite](https://vitejs.dev/) +- **Styling:** [Tailwind CSS](https://tailwindcss.com/) +- **Animations:** [Framer Motion](https://www.framer.com/motion/) +- **Icons:** [Lucide React](https://lucide.dev/) +- **Deployment:** Docker + Nginx + +## 📂 Architecture + +The project follows a modular structure for easy maintenance: + +- **`src/data/`**: Edit text, links, and team members here. +- **`src/sections/`**: Main page blocks (Hero, Projects, Team). +- **`src/components/`**: Reusable UI elements (Navbar, Buttons, Cards). +- **`src/utils/`**: Animation logic. + +## 🛠️ Setup & Run + +### Local Development + + npm install + npm run dev + +### Docker Production + +This project includes a production-ready Nginx configuration. + + # Build and start the container + docker compose up -d --build + +The site will run on port `8081` by default.