mirror-and-mountain / meros-theme-dev
A development environment for creating Meros-Powered Wordpress themes.
Installs: 2
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 0
Forks: 0
Open Issues: 0
Language:CSS
Type:project
README
MEROS THEME DEV
About
This package provides a containerised development environment for creating and working on Meros themes. It utilises a php-apache image and installs Wordpress using wp-cli. The environment will automatically create a Wordpress theme project from our Meros Blocks starter theme. The environment is compatible with Docker Desktop for local development as well as Github Codespaces.
The purpose of this environment is for creating and working on your own Meros-Powered Wordpress theme. For working on and contributing to on mirror-and-mountain's source Meros projects, please see our Meros Dev repository.
Important Note: The container built by this package is not intended for use in production environments.
Getting Started
Github Codespaces
To use this environment in Github Codespaces, you can either fork this repository and launch a Codespace from your fork, or use composer to create a project like so:
composer create-project mirror-and-mountain/meros-theme-dev meros-theme-dev
You can then initialise Git on your meros-theme-dev project and publish it to your own Github account. From there, you can launch a Codespace.
Local Development
To use this environment locally, make sure you have Docker Desktop installed and running. We also recommend using VS Code with the relevant 'devcontainer' extensions installed. You can either fork this repository and clone it to your local machine, or create a new meros-theme-dev project using Composer. Once your meros-theme-dev project is open in VS Code, you should be prompted to reopen it inside a Dev Container.
Additional Notes
- In Github Codespaces, the live Wordpress site can be found at url following this convention: "https://your-codespace-name-80.app.github.dev/wp." See the 'ports' panel in VS Code to find the link (add '/wp' to the end of it for Wordpress and '/wp/wp-admin' for the dashboard).
- In local environments, Wordpress will be available at http://localhost:8000/wp.
License
This package and the Meros Framework are open-sourced software licensed under the MIT license. Our Wordpress themes and plugins follow the Wordpress GPL licensing guidelines.