File: //var/www/e-tdr.com/e-tdr/README.md
# e-TDR Digital TDR Platform
e-TDR is a modern, high-performance Digital TDR (Terms of Reference / Technical Data Repository) platform built on WordPress. It features a premium UI design with glassmorphism effects, a responsive layout, and a robust backend powered by Advanced Custom Fields (ACF).
## 🚀 Key Features
- **Premium UI/UX**: Modern dark-themed design with urbanist typography and glassmorphism.
- **Dynamic Content**: Fully manageable sections via ACF Pro.
- **Responsive Design**: Built with Bootstrap 5 for seamless experience across all devices.
- **Digital TDR Management**: Specialized workflows for digital documentation and tracking.
- **Interactive Elements**: AJAX-powered filters, search, and dynamic modals.
## 🛠️ Tech Stack
- **Core**: WordPress (Tested up to 5.4+)
- **Backend**: PHP 5.6+, Composer
- **Frontend**: Bootstrap 5, Urbanist Google Font, Bootstrap Icons
- **Workflow**: SASS, Node.js (npm), Gulp/wp-scripts
- **Database**: MySQL/MariaDB
## 📁 Project Structure
The project follows a standard WordPress theme structure with enhancements:
- `wp-content/themes/e-tdr/`: Primary theme directory.
- `template-parts/`: Reusable UI components (Hero, CTA, etc.).
- `inc/`: Core logic and template functions.
- `sass/`: SASS source files for styling.
- `js/`: Frontend logic and interactive scripts.
## ⚙️ Development Setup
### Prerequisites
- Node.js
- Composer
### Installation
1. Navigate to the theme directory:
```sh
cd wp-content/themes/e-tdr
```
2. Install PHP dependencies:
```sh
composer install
```
3. Install JavaScript dependencies:
```sh
npm install
```
### Available Commands
- `npm run watch`: Watches for SASS changes and recompiles.
- `npm run compile:css`: Compiles SASS to CSS and runs stylelint.
- `npm run bundle`: Generates a distribution-ready .zip file.
- `composer lint:php`: Checks PHP syntax.
## 📄 License
This project is licensed under the GNU General Public License v2 or later.
---
*Built with ❤️ for the e-TDR Digital Platform.*