physio-remotion/README.md

87 lines
2.7 KiB
Markdown

# Physio-Remotion Website
A modern, clean, and mobile-optimized "Coming Soon" landing page for the physiotherapy practice **Physio-Remotion** in Erding.
## Project Overview
The website is a static landing page built with Vanilla HTML, CSS, and JavaScript. It features a responsive layout that adapts to both desktop and mobile devices, using high-quality background images of the practice.
- **Launch Date:** April 2026
- **Design:** Teal-based color palette (`#699ba4`, `#8ac3ca`) with golden accent (`#d4a373`).
- **Tech Stack:** HTML5, CSS3 (Vanilla), JavaScript, npm (for build/deploy).
## Getting Started
### Prerequisites
- **Node.js**: Required for build and deployment scripts.
- **lftp**: Required for SFTP deployment.
```bash
brew install lftp
```
### Local Setup
1. **Environment Variables**: Create a `.env` file in the root directory (already present in your repository, but ensure it has the following variables):
```env
SFTP_USER=your_user
SFTP_PASS=your_password
SFTP_HOST=your_host
SFTP_PORT=your_port
SFTP_SUB_DIR=your_remote_directory
```
2. **Install Dependencies** (Optional, for future tools):
```bash
npm install
```
### Development & Build
To prepare the website for deployment, you can run the build script which collects all necessary files into a `dist/` directory:
```bash
npm run build
```
## Deployment
The project includes an automated deployment script using SFTP.
To deploy the website to your remote server:
```bash
npm run deploy
```
**What the script does:**
1. Loads credentials from `.env`.
2. Runs `npm run build` to prepare static assets.
3. Uses `lftp` to mirror the `dist/` folder to the remote `SFTP_SUB_DIR`.
## Project Structure
```text
.
├── img/ # Visual assets (praxis images)
├── dist/ # Generated build artifacts (gitignored)
├── index.html # Main landing page
├── impressum.html # Legal notice (Draft)
├── datenschutz.html # Privacy policy (Draft)
├── style.css # Global styles
├── main.js # Basic site logic
├── deploy.sh # SFTP deployment bash script
├── .env # SFTP credentials (gitignored)
├── .gitignore # Git ignore rules
└── package.json # Project metadata and scripts
```
## Legal Requirements
> [!IMPORTANT]
> This is a draft version. Before going public, please ensure the following:
> 1. Complete the placeholder information in `impressum.html` (Full names, insurance details, etc.).
> 2. Complete the placeholder information in `index.html` (Phone number).
> 3. Verify the `datenschutz.html` with a legal professional.
---
© 2025 Physio-Remotion