Add docs and gitignore

This commit is contained in:
2025-12-18 17:16:37 +00:00
parent 8f1cd47c45
commit c1a2bc174f
2 changed files with 86 additions and 0 deletions

49
.gitignore vendored Normal file
View File

@@ -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

37
README.md Normal file
View File

@@ -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.