Skip to content

ChrisHursty/rb-homes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

R&B Homes WP Theme

R&B Homes WP is a custom WordPress theme designed for a UK Letting & Building Agency

Prerequisites

  • WordPress environment (Local by Flywheel, XAMPP, MAMP, etc.)
  • Node.js and npm

Installation

  1. Clone the Repository:
    Clone this repository into your WordPress themes directory.

    git clone https://github.com/ChrisHursty/rb-homes
  2. Navigate to the Theme Directory:
    Change to the theme directory.

  3. Install Node Modules:
    Install the required Node modules.

    npm install
  4. Install SASS (Maybe):
    Install SASS.

    npm install sass

    I had to do this while testing on an (older) machine.

  5. Setting Local for Live Reload Open the gulpfile.mjs and update the proxy:

    browserSyncInstance.init({
        proxy: "change_to_your_local_install.local/"
    });
  6. 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.

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

Structure

  • /scss: SCSS files for styling.
  • /css: Compiled CSS files.
  • /js: JavaScript files.
  • functions.php: WordPress theme functions.
  • index.php: Main template file.

Contributing

Contributions to the R&B Homes WP theme are welcome. Please ensure you follow the existing code structure and style.

  1. Fork the repository.
  2. Create a new branch for your feature (git checkout -b feature/AmazingFeature).
  3. Commit your changes (git commit -m 'Add some AmazingFeature').
  4. Push to the branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request.

License

Distributed under the MIT License. See LICENSE for more information.

Dependencies

Credits

Fonts

About

R&B Homes WP is a custom WordPress theme designed for a UK Letting & Building Agency

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors