Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scandipwa/create-magento-app
A zero-configuration tool-chain which allows to deploy Magento 2 application in minutes!
https://github.com/scandipwa/create-magento-app
cli developer-tools docker magento2
Last synced: about 1 month ago
JSON representation
A zero-configuration tool-chain which allows to deploy Magento 2 application in minutes!
- Host: GitHub
- URL: https://github.com/scandipwa/create-magento-app
- Owner: scandipwa
- License: osl-3.0
- Created: 2020-11-10T17:25:32.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-09T15:53:57.000Z (about 1 month ago)
- Last Synced: 2024-10-10T14:54:05.815Z (about 1 month ago)
- Topics: cli, developer-tools, docker, magento2
- Language: JavaScript
- Homepage: https://docs.create-magento-app.com
- Size: 8.01 MB
- Stars: 31
- Watchers: 4
- Forks: 20
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
A zero-configuration tool-chain which allows to deploy Magento 2 application in minutes!
- [Creating an App](https://docs.create-magento-app.com/getting-started/getting-started) – How to create a new app.
- [Available commands](https://docs.create-magento-app.com/getting-started/available-commands) – Learn how to use apps bootstrapped with Create Magento App.
## Most important features
### Conflict-less design 🤝
The application will automatically select free ports. It will never let services previously installed on your machine down!
**Screwed a local installation?** Worry not, Create Magento App will set you up!
### Easy debugging 🐛
The powerful [XDebug tool](https://docs.create-magento-app.com/usage-guide/enabling-xdebug) is a single command-line option flag away from you!
## Creating an App
**You’ll need to have Node >= 12 on your local development machine**. You can use [n](https://www.npmjs.com/package/n) to switch Node versions between different projects.
**You’ll need to install platform specific dependencies** for [Linux](https://docs.create-magento-app.com/getting-started/prerequisites/installation-on-linux), [MacOS](https://docs.create-magento-app.com/getting-started/prerequisites/installation-on-macos) and [Windows](https://docs.create-magento-app.com/getting-started/prerequisites/windows-requirements).
To create a new app, you may choose one of the following methods:
#### NPX
```bash
npx create-magento-app my-app
```
[npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher
#### NPM
```bash
npm init magento-app my-app
```
`npm init ` is available in npm 6+
#### Yarn
```bash
yarn create magento-app my-app
```
`yarn create` is available in Yarn 0.25+
## Contribution
We'd love to have your helping hand on `create-magento-app`! See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information on what we're looking for and how to get started.
Thanks to these **awesome** :heart: people for contribution!
## License
Create Magento App is open source software licensed as [OSL-3.0](./LICENSE).