mage-wizard

KO | EN

gitlite — search

#typescript #android #deep-learning #linux #docker #java #windows #awesome #cli #kubernetes #awesome-list #pytorch #ios #open-source

(★ 20)

Develop faster on Magento / Adobe Commerce with Mage Wizard

mage-wizard 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Mage Wizard

---

<div align="center">
📖 <a href="https://mage-wizard.dev"><strong>Documentation</strong></a>
</div>

---

> [!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 <path-to-magento-root>:/magento clickandmortar/mage-wizard
```

Replace `<path-to-magento-root>` 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.

mage-wizard

mage-wizard 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

mage-wizard

mage-wizard 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README