R&B Homes WP is a custom WordPress theme designed for a UK Letting & Building Agency
- WordPress environment (Local by Flywheel, XAMPP, MAMP, etc.)
- Node.js and npm
-
Clone the Repository:
Clone this repository into your WordPress themes directory.git clone https://github.com/ChrisHursty/rb-homes
-
Navigate to the Theme Directory:
Change to the theme directory. -
Install Node Modules:
Install the required Node modules.npm install
-
Install SASS (Maybe):
Install SASS.npm install sass
I had to do this while testing on an (older) machine.
-
Setting Local for Live Reload Open the
gulpfile.mjsand update theproxy:browserSyncInstance.init({ proxy: "change_to_your_local_install.local/" }); -
Running the Development Environment (
gulp serve):
Start the development environment with live reloading.npx gulp
This command starts a local development server with BrowserSync and watches your SASS, JS, and PHP files for changes, automatically reloading the browser.
-
Building for Production (
gulp build):
To prepare your theme for a production environment, use:gulp build
This command runs tasks for compiling SASS, minifying CSS and JS files, optimizing images, and packaging your theme into a zip file. Ensure to run this command before deploying your theme.
/scss: SCSS files for styling./css: Compiled CSS files./js: JavaScript files.functions.php: WordPress theme functions.index.php: Main template file.
Contributions to the R&B Homes WP theme are welcome. Please ensure you follow the existing code structure and style.
- Fork the repository.
- Create a new branch for your feature (
git checkout -b feature/AmazingFeature). - Commit your changes (
git commit -m 'Add some AmazingFeature'). - Push to the branch (
git push origin feature/AmazingFeature). - Open a Pull Request.
Distributed under the MIT License. See LICENSE for more information.
- Font Awesome integration (v5.15.4)
- Owl Carousel 2
- Magnific Popup