| Tudásbázis WordPress theme

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
  • WordPress setup
  • Scripts
• License
• Changelog
• Code Style
• Documentation
• Contact
• Acknowledgements

About The Project

Astro is a custom WordPress theme for the Rackhost/tudásbázis.

Built With

• Wordpress 5.7
• Bootstrap 5
• Sass
• Webpack

Getting Started

You can easily install this theme and add it to your WordPress site.

Prerequisites

• A running WordPress site (v5.4+)
  • WordPress Advanced Custom Fields plugin
• node.js (v14.17.1+)
• npm package manager (v6.14.13+) included with node.js

Installation

git clone https://gitlab.rackhost.hu/rackhost/wp-tudasbazis.git
cd wp-tudasbazis/assets
npm install
npm run dev

Usage

WordPress Setup

To use the theme first bundle your src files

cd path/to/source/assets
npm run bundle

After the bundling has finished go to your WordPress admin site:

1. In your admin panel, go to Appearance > Themes and click the Add New button.
2. Click Upload Theme and Choose File, then select the astro.zip file. Click Install Now.
3. Click Activate and then configure the theme settings and Advanced Custom Fields according to the docs.

Scripts

Our package.json file comes with some useful scripts to use.

• npm run prod build the production files with Webpack, optimizing our source files
• npm run dev builds the development files with Webpack and listens to file changes inside the assets directory, and rebuilds on save for easy development.
• npm run bundle command builds with the production settings and then bundles the necessary files for WordPress Theme together in a .zip file.
• npm run clean command deletes the assets/build directory for a clean slate.
• npm run translations creates astro.pot translations file
• npm run build-translations builds .mo from .po files

License

WordPress (.php) files is distributed under the GPLv3 license. See LICENSE.md for more information. All other files under /assets is distributed under a proprietary license. See assets/LICENSE.md for more information.

Changelog

All notable changes to this project will be documented in CHANGELOG.md.

Code Style

The project adhere to the guidelines defined below:

• Project versioning uses Semantic Versioning 2.0.0
• Commits use the Conventional Commits style
• PHP files use the PSR-12 extended coding style instead of the WordPress coding standards
• Sass files use style defined in Sass guidelines
• Javascript files adhere to the Airbnb JavaSript Style Guide

Documentation

For a detailed explanation of the project please refer to the /docs

Contact

Kristóf Gábor - gaborkristof@protonmail.com

Project Link: https://gitlab.rackhost.hu/rackhost/wp-tudasbazis/

Acknowledgements

• Bootstrap, licensed under MIT