- About the Project
- Getting Started
- Usage
- License
- Changelog
- Code Style
- Documentation
- Contact
- Acknowledgements
Astro is a custom WordPress theme for the Rackhost/tudásbázis.
You can easily install this theme and add it to your WordPress site.
- 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
git clone https://gitlab.rackhost.hu/rackhost/wp-tudasbazis.git
cd wp-tudasbazis/assets
npm install
npm run dev
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:
- In your admin panel, go to
Appearance
>Themes
and click theAdd New
button. - Click Upload Theme and Choose File, then select the
astro.zip
file. Click Install Now. - Click
Activate
and then configure the theme settings and Advanced Custom Fields according to thedocs
.
Our package.json
file comes with some useful scripts to use.
npm run prod
build the production files with Webpack, optimizing our source filesnpm run dev
builds the development files with Webpack and listens to file changes inside theassets
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 theassets/build
directory for a clean slate.npm run translations
createsastro.pot
translations filenpm run build-translations
builds.mo
from.po
files
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.
All notable changes to this project will be documented in CHANGELOG.md.
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
For a detailed explanation of the project please refer to
the /docs
Kristóf Gábor - [email protected]
Project Link: https://gitlab.rackhost.hu/rackhost/wp-tudasbazis/
- Bootstrap, licensed under MIT