Files
wp-bootstrap/README.md

81 lines
1.9 KiB
Markdown
Raw Normal View History

# WP Bootstrap
A modern WordPress Block Theme built from scratch with Bootstrap 5.
## Features
- Full Site Editing (FSE) support
- Bootstrap 5 CSS and JavaScript
- Responsive design
- Dark mode ready (Bootstrap 5.3 dark mode variables)
- Twig 3.0 template engine
- WordPress i18n support
- Gitea CI/CD automated releases
## Requirements
- WordPress 6.7 or higher
- PHP 8.3 or higher
## Installation
### From Release Package
1. Download the latest `.zip` from [Releases](https://src.bundespruefstelle.ch/magdev/wp-bootstrap/releases)
2. Go to WordPress Admin > Appearance > Themes > Add New > Upload Theme
3. Upload the ZIP file and activate
### From Source
```bash
git clone ssh://git@src.bundespruefstelle.ch:2022/magdev/wp-bootstrap.git
cd wp-bootstrap
composer install
yarn install
yarn build
```
## Development
### Prerequisites
- Node.js 20+
- Yarn
- Composer
- PHP 8.3+
### Build Commands
| Command | Description |
| --- | --- |
| `yarn build` | Compile SCSS, minify CSS, copy Bootstrap JS |
| `yarn dev` | Watch SCSS files and recompile on changes |
| `yarn scss` | Compile SCSS only |
| `yarn postcss` | Minify CSS with Autoprefixer |
| `composer install` | Install PHP dependencies |
### Project Structure
```txt
wp-bootstrap/
├── assets/ Compiled CSS, JS, and images
├── inc/ PHP classes (PSR-4 autoloaded)
├── languages/ Translation files (.pot, .po)
├── parts/ FSE template parts (header, footer)
├── patterns/ Block patterns
├── src/scss/ SCSS source files
├── templates/ FSE page templates
├── views/ Twig templates
├── functions.php Theme bootstrap
├── style.css Theme metadata
└── theme.json Design tokens and settings
```
## License
GPL-2.0-or-later
## Author
Marco Graetsch - [src.bundespruefstelle.ch/magdev](https://src.bundespruefstelle.ch/magdev)