Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clickAndMortar/mage-wizard
https://github.com/clickAndMortar/mage-wizard
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/clickAndMortar/mage-wizard
- Owner: ClickAndMortar
- Created: 2023-08-29T14:42:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-26T12:33:30.000Z (about 1 year ago)
- Last Synced: 2024-03-26T16:45:17.370Z (9 months ago)
- Language: TypeScript
- Size: 854 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-magento2 - Mage Wizard - Local web UI to view and create automatically modules, plugins, configs, observers, commands, crontabs, etc. directly in Magento 2 codebase (Tools / Meet Magento)
- awesome-magento2 - Mage Wizard - Local web UI to view and create automatically modules, plugins, configs, observers, commands, crontabs, etc. directly in Magento 2 codebase (Tools / Meet Magento)
README
# Mage Wizard
---
---
> [!WARNING]
> Mage Wizard is currently in beta. Use carefully in a development environment.
> Always work on version-controlled code, or backup your code before making changes.
> Please report any issues you find, or any suggestions you have.
Mage Wizard is a web-based tool to help you developer faster on Magento / Adobe Commerce 2.4+:
* Generate a new module
* Generate / edit code:
* System configs
* Models
* Patches
* Commands
* Crontab jobs
* Admin grids (coming soon)
* Plugins
* Observers
* Email templates
* View configuration:
* Modules
* Tables (from `db_schema.xml`)
* Crontab jobs
* CLI commands
* Plugins
* Observers
* Email templates
* Analyse Composer dependencies
## Local requirements
- [Node.js](https://nodejs.org/en/) (`18.x` or newer)
- [Magento / Adobe Commerce](https://magento.com/) (`2.4.x` or newer)
## Usage
### Using npx
```shell
npx mage-wizard@latest
```
Open http://localhost:3000 in your browser.
### Using Docker
```shell
docker run -p 3000:3000 -v :/magento clickandmortar/mage-wizard
```
Replace `` with the path to your Magento / Adobe Commerce root directory.
Open http://localhost:3000 in your browser, and when prompted, use `/magento` as the Magento root path.
> [!NOTE]
> Remember to frequently run `docker pull clickandmortar/mage-wizard` to get the latest version.
### Installing globally using npm
```shell
npm install -g mage-wizard
mage-wizard
```
Open http://localhost:3000 in your browser.
### Environment variables
| Name | Description | Default value |
|--------|-------------------|---------------|
| `PORT` | Port to listen on | `3000` |
| `HOST` | Host to listen on | `127.0.0.1` |
## Development
### Requirements
- [npm](https://npmjs.com/)
### Setup
```bash
npm install
```
### Development server
Start the development server on `http://localhost:3000`:
```bash
npm run dev
```
## Build and deployment
```shell
# Bumps the version in package.json and creates a new commit with updated CHANGELOG.md
npm run release
git push --follow-tags origin main
```
When a tag is pushed, the GitHub Actions workflow will:
* Build and deploy the package to [npm](https://www.npmjs.com/package/mage-wizard): see [`.github/workflows/npm.yaml`](.github/workflows/npm.yaml)
* Build and push the Docker image to [Docker Hub](https://hub.docker.com/r/clickandmortar/mage-wizard): see [`.github/workflows/docker.yaml`](.github/workflows/docker.yaml)
## Documentation
The documentation (located under `docs/`) is written in Markdown and rendered using [VitePress](https://vitepress.dev/).
To start the documentation server locally, run:
```shell
npm run docs:dev
```
### Publishing the documentation
The documentation is automatically published to [mage-wizard.dev](https://mage-wizard.dev) using GitHub Pages.
See the [`.github/workflows/docs.yaml`](.github/workflows/docs.yaml) workflow for more details.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
This project is not affiliated with, endorsed by, or sponsored by Adobe Inc.
"Magento" and "Adobe Commerce" are trademarks of Adobe Inc.
All trademarks and registered trademarks are the property of their respective owners.