From 1b8625bfd5313fdccef2f07d271eecb76225c7f6 Mon Sep 17 00:00:00 2001 From: jamesgeorge007 Date: Thu, 13 Aug 2020 22:52:13 +0530 Subject: [PATCH] chore: minor tweaks --- CHANGELOG.MD | 326 ------------------ README.md | 7 +- __e2e__/commands/add.test.js | 2 +- __e2e__/commands/generate.test.js | 2 +- docs/.vuepress/config.js | 2 +- docs/guide/README.md | 59 +++- docs/guide/commands.md | 25 -- docs/guide/gettingstarted.md | 15 + package-lock.json | 12 +- src/commands/basic/add.js | 4 +- src/commands/basic/init.js | 2 +- .../starter-templates/Default/README.md | 35 +- .../Default/public/index.html | 4 +- .../Default/src/views/Home.vue | 2 +- .../starter-templates/GraphQL/README.md | 35 +- .../starter-templates/Nuxt.js/README.md | 21 +- src/templates/starter-templates/pwa/README.md | 35 +- 17 files changed, 88 insertions(+), 500 deletions(-) delete mode 100644 CHANGELOG.MD delete mode 100644 docs/guide/commands.md create mode 100644 docs/guide/gettingstarted.md diff --git a/CHANGELOG.MD b/CHANGELOG.MD deleted file mode 100644 index 2c31d08fc..000000000 --- a/CHANGELOG.MD +++ /dev/null @@ -1,326 +0,0 @@ -# Changelog -All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - -# v1.7.5 - -## What's new - -- Generate route entries conditionally based on the user choice. Firing in `mevn generate` now prompts the user whether he requires a UI component / page component. -- Inherits `stdio` for `mevn serve`. As opposed to showing up a spinner, now the direct output is being logged. - -## Bug fixes - -- Fixed `Vuetify` installation with `Nuxt.js` - -# v1.7.0 - -## What's new - -- Use of dot file to store information specific to the project, `mevn.json` -> `.mevnrc` -- Revamped `deploy` experience. (#151) -- Fixed the inconsistencies with `serve` command in which the browser window won't open up at times. (#164) -- `mevn generate` won't show up all the options unless you're having a full-stack app. -- Other fixes adding to the DX. - -## Issues closed - -- [#151](https://github.com/madlabsinc/mevn-cli/issues/151) -- [#164](https://github.com/madlabsinc/mevn-cli/issues/164) - -# v1.6.5 - -## Bug fixes - -- Fixed a critical bug in the previous release [1.6.2](https://github.com/madlabsinc/mevn-cli/releases/tag/v1.6.2) -- Fixed [#148](https://github.com/madlabsinc/mevn-cli/issues/148) - -## Features - -- Warn if the user attempts to create yet another app within a valid MEVN stack project - - Updated banner - -# v1.6.2 - -> Deprecated - -Introduced a critical bug fixed in [1.6.5](https://github.com/madlabsinc/mevn-cli/releases/tag/v1.6.5) - -# v1.6.1 - -## Fix - -- Critical bug fix (Configure `@babel/polyfill`) - -# v1.6.0 - -## Features - -- Revamped commands -- Supports `surge.sh` for SPA deployments -- Better refactored code-base -- Automates the process of updating route config within `main.js` on generating components with `mevn generate` -- Out of the box support to add new plugins and lazy load components as required -- Use `mevn add` to install additional plugins on the go. - -## Internal changes - -- Switch to a single repository for the boilerplate templates: [mevn-starter-kit](http://github.com/madlabsinc/mevn-starter-templates) - - -## Breaking changes - -- Rename `mevn add:package` to `mevn add` - -# v1.5.1 - -## Fixes - -- Removed unworth logs. -- Minor bug fixes. - -## v1.5.0 - -## Internal Changes - -- Critical bug fixes. -- Code refactor. -- Use [node-banner](https://npmjs.com/package/node-banner) for displaying banner. - -## Removed dependencies - -- shelljs -- figlet -- clear - - -# v1.4.8 - -## Internal changes - -- Minor change in directory hierarchy -- Add constants entry -- Updated banner - -## Other changes - -- Update Docs -- Minor bug fixes - -# v1.4.7 - -## Fixes - -- Updated the commands list to be in sync with the latest changes (`mevn init`). -- Docs update - -# v1.4.6 - -## Fixes - -Minor bug fixes - (validate installation) - -## Commits - -- [0da5058](https://github.com/madlabsinc/mevn-cli/commit/0da5058cc2c2ca890bf6e93102a33ee7cc971e14) -- [f564f8f](https://github.com/madlabsinc/mevn-cli/commit/f564f8fca737749834f53cfa5b8fb9374877f7f7) - -# v1.4.5 - -## Features - -- Provides `pwa` support for the `Nuxt-js` template. #74 -- `mevn deploy` works out of the box. -- Slightly updated banner. - -## Internal Changes - -- Use [open](https://npmjs.com/package/open) instead of [opn](https://npmjs.com/package/opn) (deprecated). -- Avoid the use of `os` module. -- Adopted a promisified approach rather than using`deferExec()` in-order to cope up with the `async` nature. - -- Other minor bug fixes - -# v1.4.3 - -## API Changes - -- Suggest matching commands -- New `info` command that prints local environment information -- Use `-v, --version` options and deprecate `version` command -- Updated demo - -# v1.4.1 - -## Fixes - -- Fixed a minor bug (Showing up incorrect path). [0be5821](https://github.com/madlabsinc/mevn-cli/commit/0be5821355a76c680c9c503f2f19a9200be26832) - -# v1.4.0 - -## API change - -## Breaking changes - -- Removed `create:git-repo` command and made it such that an initial commit is made with `mevn init`. -- Removed `create:component` command included it as part of `generate`. - -## Other changes - -- Improvements to the code-base -- Minor bug fixes [#111](https://github.com/madlabsinc/mevn-cli/pull/111) - -# v1.3.5 - -## Fixes - -> Fixed a bug encountered while installing the package via `npm` - -# v1.3.3 - -## Fixes - -> Minor tweaks - -# v1.3.2 - -## Fixes - -> Bugs fixed - -# v1.3.1 - -## Fixes - -> Minor bug fix - -# v1.3.0 - -## Fixes - -> This release beings about improvements to the codebase such as:- - -- Use ESM import statement to include the required dependencies. -- Migrate from `Jshint` to `eslint` with babel and prettier presets. -- Minor changes to project structure -- Minor bug fixes - -# v1.2.8 - -## Fixes - -- [c5f17e7](https://github.com/madlabsinc/mevn-cli/commit/c5f17e796bd37c53c4be73eec9973cb837799ecb) - Fixed the bugs with validating `git` installation - - -# v1.2.7 - -## Fixes - -> Prompts the user if the required dependencies to work with are not installed and proceeds with the installation as per choice. - -## Commits - -- [15e81c7](https://github.com/madlabsinc/mevn-cli/commit/15e81c70729943ea76c504e418c1dee342b8ba23) -- [788709c](https://github.com/madlabsinc/mevn-cli/commit/788709c089415d259d6d9a69fdfdd8a4b6265fd1) -- [6ded326](https://github.com/madlabsinc/mevn-cli/commit/6ded326adb306b5c8bb6686deacacd914d3fb49f) - -# v1.2.5 - -## Fixes - -- [1978efd](https://github.com/madlabsinc/mevn-cli/commit/1978efd84ab4a1de8bfcc5b6ad8c0b19a4b78afc) - Fixed the bug encountered while serving the template. - -# v1.2.3 - -## Fixes - -- [dbdce46](https://github.com/madlabsinc/mevn-cli/commit/dbdce46b58e99abf2046cec88905c89e3cb8d8e8) - Fixed the bug while serving GraphQL template. - -# v1.2.1 - -## Commits - -- [2586204](https://github.com/madlabsinc/mevn-cli/commit/25862045f8956681bcf4d3e7661ef222007a243e) -- [0f378c0](https://github.com/madlabsinc/mevn-cli/commit/0f378c0a5347ac5c643df4fd14be03c0a6b50e84) -- [594e030](https://github.com/madlabsinc/mevn-cli/commit/594e030b017a04d18c2acf5a23342a40c3993138) - -# v1.2.0 - -## Breaking Changes - -- Change `mevn run:client/server` to `mevn serve` - -## Commits - -- [a633004](https://github.com/madlabsinc/mevn-cli/commit/a633004513021766bae8f4dbff81a674aaaff0c1) -- [44fc9e3](https://github.com/madlabsinc/mevn-cli/commit/44fc9e34075a363fc05a02753716e31e46ddce2e) - -# v1.1.9 - -## Fixes - -- [2c838dc](https://github.com/madlabsinc/mevn-cli/commit/2c838dc8d1b2be78bc76633ae3f93b97ff408a8a) - Shows up required warnings if mevn generate is used with graphql boilerplate - -# v1.1.8 - -## Fixes - -- [d01f6b2](https://github.com/madlabsinc/mevn-cli/commit/d01f6b21459de1ecc5ca5e7c3ec300318c4648d9) - Replaced create file commands with a generate command. -- [2e334d5](https://github.com/madlabsinc/mevn-cli/commit/2e334d59f110911f1dc15f66f13eea07f1360331) - -Migrate to `cli-table3` -- Docs related updates - -# v1.1.5 - -## Fixes - -- [#92](https://github.com/madlabsinc/mevn-cli/pull/92) - Validates docker installation locally -- [#93](https://github.com/madlabsinc/mevn-cli/pull/93) - Update file hierarchy within docs -- [#94](https://github.com/madlabsinc/mevn-cli/pull/94) - Validation for heroku-cli installation - -# v1.1.0 - -## Changes - -- [`0584d59`](https://github.com/madlabsinc/mevn-cli/commit/0584d59106333ad9ebffde2c9c3b972414d7b41e) Update demo within Docs - -# v1.0.9 - -## Fixes - -- Fixed a bug that arised when a directory having same name as the boilerplate template already exists in the current path [#88](https://github.com/madlabsinc/mevn-cli/pull/88) - -# v1.0.8 - -## Fixes - -- Fix for [#86](https://github.com/madlabsinc/mevn-cli/pull/86) - now you can find `mevn.json` within the new project being created - -# v1.0.5 - -## Fixes - -- Fixed bug while fetching the Nuxt-js template -- Other minor bug fixes - -# v1.0.1 - -## Fixes - -- Core functionalities implemented. - -# v0.0.2 - -## Fixes - -- Bug fixes and code cleanup -- Update README.md -- Test vuepress for docs - -# v0.0.1 - -## Initial release - -- Includes basic functionalities. diff --git a/README.md b/README.md index b751b86b5..039b57d60 100644 --- a/README.md +++ b/README.md @@ -29,11 +29,6 @@ A CLI tool for getting started with the MEVN stack. The acronym “MEVN” stands for “MongoDB Express.js VueJS Node.js”. It offers a super-simple boilerplate template and additional utilities for building a MEVN stack-based webapp. It takes away the hassle of setting up the local development environment which may become a nightmare especially for beginners who are just starting. -- [Basic](http://github.com/madlabsinc/mevn-starter-templates/) -- [Pwa](http://github.com/madlabsinc/mevn-starter-templates/tree/pwa) -- [GraphQL](http://github.com/madlabsinc/mevn-starter-templates/tree/graphql) -- [Nuxt.js](http://github.com/madlabsinc/mevn-starter-templates/tree/nuxt) - ## Installation ### Prerequisites @@ -68,7 +63,7 @@ mevn init - It allows Developers to build webapps with ease in which all the local environment setup is being taken care of. All they have to do is to focus on writing actual code. - The whole project is done in modules(thanks to ES6 syntax) which enhances user readability and leads to compact code. -- MEVN-CLI simplifies developer workflow by generating boilerplate code as required and automating redundant tasks. +- MEVN-CLI simplifies developer workflow by generating the required boilerplate and automating redundant tasks. ## Contributing diff --git a/__e2e__/commands/add.test.js b/__e2e__/commands/add.test.js index de527821d..9a1fe0884 100644 --- a/__e2e__/commands/add.test.js +++ b/__e2e__/commands/add.test.js @@ -127,7 +127,7 @@ describe('mevn add', () => { await runPromptWithAnswers( ['init', 'my-app'], [ - ENTER, // Choose basic template + ENTER, // Choose Default as the starter template `Y${ENTER}`, // Requires server directory ], tempDirPath, diff --git a/__e2e__/commands/generate.test.js b/__e2e__/commands/generate.test.js index 2c49f3d31..f07256a52 100644 --- a/__e2e__/commands/generate.test.js +++ b/__e2e__/commands/generate.test.js @@ -31,7 +31,7 @@ describe('mevn generate', () => { await runPromptWithAnswers( ['init', 'my-app'], [ - ENTER, // Choose basic template + ENTER, // Choose Default as the starter template `Y${ENTER}`, // Requires server directory ], tempDirPath, diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 4bf217ed3..0d32c1359 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -15,8 +15,8 @@ module.exports = { title: 'Guide', collapsable: false, children: [ + 'gettingstarted', 'installation', - 'commands', 'features', 'contributing' ] diff --git a/docs/guide/README.md b/docs/guide/README.md index 0c38e943d..bb93718ff 100644 --- a/docs/guide/README.md +++ b/docs/guide/README.md @@ -1,21 +1,60 @@ --- -title: 'Getting Started' +title: 'Available Commands' --- -# Getting Started +# Available Commands -## What is MEVN-CLI ? + `MEVN-CLI` offers the following set of commands:- -A CLI tool for getting started with the MEVN stack. It offers a super simple boilerplate template and additional utilities for building a MEVN stack based webapp. It takes away the hassle of setting up the local development environment which may become a nightmare especially for beginners who are just starting out. +- ### `mevn init ` -## Why MEVN-CLI ? +Choose between the four available starter templates to build on top of. -As per the traditional approach, Developers are required to make their hands dirty setting up the local development environment which can be a pain especially for beginners (as mentioned above). Also, it consumes time which can be utilised in building the actual product. We can also see this in the deployment phase where they may face trouble. All these can serve as demotivating factors for novices. It is here where MEVN-CLI comes into play. It offers a super simple boilerplate project, a reliable boilerplate for pwa, GraphQL, Nuxt-js and additional utilities for building a MEVN stack app. +[![asciicast](https://asciinema.org/a/353232.svg)](https://asciinema.org/a/353232) -The main aim of MEVN-CLI is to make Developers productive such that all they require is to focus on building the actual product while it takes care of all the local development environment setup as well . Significant features include:- +- ### `mevn serve` -- Choose the template of your choice:- The user has the provision to choose from a basic, PWA, Nuxt-js and GraphQL template which serves as a platform to build upon. The user has the provision to choose between his database of choice (Mongo DB / MySQL) where in which mongoose and sequelize serves as the ODM and ORM respectively. +Serve the webapp locally. -- Run your application within a Docker container:- With MEVN-CLI all the user has to do is fire in a single command with which it pulls in the required docker image and your web-app will be served locally within a Docker container. +[![asciicast](https://asciinema.org/a/353239.svg)](https://asciinema.org/a/353239) -- Add additional packages as required on the go Just fire in a command with which you can add additional packages like vuetify, vuex-store etc. It also allows to create components with a single command. +- ### `mevn add [deps]` + +Add additional dependencies on the go. + +[![asciicast](https://asciinema.org/a/353241.svg)](https://asciinema.org/a/353241) + +- ### `mevn generate` + +Generate client side components (SFC) or CRUD Boilerplate for the server. + +[![asciicast](https://asciinema.org/a/353245.svg)](https://asciinema.org/a/353245) + +- ### `mevn codesplit` + +Lazy load components as required. + +[![asciicast](https://asciinema.org/a/353246.svg)](https://asciinema.org/a/353246) + +- ### `mevn dockerize` + +Configure multi-container Docker application with ease. + +[![asciicast](https://asciinema.org/a/353249.svg)](https://asciinema.org/a/353249) + +- ### `mevn deploy` + +Deploy the webapp to a cloud solution of choice. + +[![asciicast](https://asciinema.org/a/353251.svg)](https://asciinema.org/a/353251) + +- ### `mevn info` + +Prints debugging information about the local environment, useful while submitting bug reports. + +## Versioning And Help + +| option | description +| --- | --- | +| -V, --version | Check CLI version | +| --help, -h | Get help and check usage | diff --git a/docs/guide/commands.md b/docs/guide/commands.md deleted file mode 100644 index 3206502a0..000000000 --- a/docs/guide/commands.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: 'Available Commands' ---- - -# Available Commands - - `MEVN-CLI` offers the following set of commands:- - -| command | description | -| -------------- | ---------------- | -| mevn init <appname> | Scaffolds a MEVN stack project in the current path | -| mevn serve | Serves the client/server side template locally | -| mevn add [deps] | Add additional dependencies as required on the go | -| mevn generate | Generates component files for the client and CRUD boilerplate template for the server | -| mevn codesplit | Lazy load components as required | -| mevn dockerize | Serves the webapp as a multi-container Docker application | -| mevn deploy | Deploys the webapp to a cloud service of choice | -| mevn info | Prints debugging information about the local environment | - -## Versioning And Help - -| option | description -| --- | --- | -| -V, --version | Check CLI version | -| --help, -h | Get help and check usage | diff --git a/docs/guide/gettingstarted.md b/docs/guide/gettingstarted.md new file mode 100644 index 000000000..1e2347a6f --- /dev/null +++ b/docs/guide/gettingstarted.md @@ -0,0 +1,15 @@ +--- +title: 'Getting Started' +--- + +# Getting Started + +## What is MEVN-CLI ? + +A CLI tool for getting started with the MEVN stack. It offers a super-simple boilerplate template and additional utilities for building a MEVN stack-based webapp. It takes away the hassle of setting up the local development environment which may become a nightmare especially for beginners who are just starting out. + +## Why MEVN-CLI ? + +As per the traditional approach, Developers are required to make their hands dirty setting up the local development environment which can be a pain, especially for beginners (as mentioned above). Also, it consumes time which can be utilized in building the actual product. We can also see this in the deployment phase where they may face trouble. All these can serve as demotivating factors for novices. It is here where MEVN-CLI comes into play. It offers a super-simple boilerplate project, a reliable boilerplate for PWA, GraphQL, Nuxt-js, and additional utilities for building a MEVN stack app. + +The main aim of MEVN-CLI is to make Developers productive such that all they require is to focus on building the actual product. diff --git a/package-lock.json b/package-lock.json index 3a385f459..52488c1d3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -7072,7 +7072,7 @@ }, "browserify-aes": { "version": "1.2.0", - "resolved": "https://registry.npmjs.org/browserify-aes/-/browserify-aes-1.2.0.tgz", + "resolved": "http://registry.npmjs.org/browserify-aes/-/browserify-aes-1.2.0.tgz", "integrity": "sha512-+7CHXqGuspUn/Sl5aO7Ea0xWGAtETPXNSAjHo48JfLdPWcMng33Xe4znFvQweqc/uzk5zSOI3H52CYnjCfb5hA==", "dev": true, "requires": { @@ -7109,7 +7109,7 @@ }, "browserify-rsa": { "version": "4.0.1", - "resolved": "https://registry.npmjs.org/browserify-rsa/-/browserify-rsa-4.0.1.tgz", + "resolved": "http://registry.npmjs.org/browserify-rsa/-/browserify-rsa-4.0.1.tgz", "integrity": "sha1-IeCr+vbyApzy+vsTNWenAdQTVSQ=", "dev": true, "requires": { @@ -9209,7 +9209,7 @@ }, "create-hash": { "version": "1.2.0", - "resolved": "https://registry.npmjs.org/create-hash/-/create-hash-1.2.0.tgz", + "resolved": "http://registry.npmjs.org/create-hash/-/create-hash-1.2.0.tgz", "integrity": "sha512-z00bCGNHDG8mHAkP7CtT1qVu+bFQUPjYq/4Iv3C3kWjTFV10zIjfSoeqXo9Asws8gwSHDGj/hl2u4OGIjapeCg==", "dev": true, "requires": { @@ -9222,7 +9222,7 @@ }, "create-hmac": { "version": "1.1.7", - "resolved": "https://registry.npmjs.org/create-hmac/-/create-hmac-1.1.7.tgz", + "resolved": "http://registry.npmjs.org/create-hmac/-/create-hmac-1.1.7.tgz", "integrity": "sha512-MJG9liiZ+ogc4TzUwuvbER1JRdgvUFSB5+VR/g5h82fGaIRWMWddtKBHi7/sVhfjQZ6SehlyhvQYrcYkaUIpLg==", "dev": true, "requires": { @@ -9995,7 +9995,7 @@ }, "diffie-hellman": { "version": "5.0.3", - "resolved": "https://registry.npmjs.org/diffie-hellman/-/diffie-hellman-5.0.3.tgz", + "resolved": "http://registry.npmjs.org/diffie-hellman/-/diffie-hellman-5.0.3.tgz", "integrity": "sha512-kqag/Nl+f3GwyK25fhUMYj81BUOrZ9IuJsjIcDE5icNM9FJHAVm3VcUDxdLPoQtTuUylWm6ZIknYJwwaPxsUzg==", "dev": true, "requires": { @@ -22779,7 +22779,7 @@ }, "sha.js": { "version": "2.4.11", - "resolved": "https://registry.npmjs.org/sha.js/-/sha.js-2.4.11.tgz", + "resolved": "http://registry.npmjs.org/sha.js/-/sha.js-2.4.11.tgz", "integrity": "sha512-QMEp5B7cftE7APOjk5Y6xgrbWu+WkLVQwk8JNjZ8nKRciZaByEW6MubieAiToS7+dwvrjGhH8jRXz3MVd0AYqQ==", "dev": true, "requires": { diff --git a/src/commands/basic/add.js b/src/commands/basic/add.js index 363f5cbe4..70974c199 100644 --- a/src/commands/basic/add.js +++ b/src/commands/basic/add.js @@ -144,7 +144,7 @@ const addDeps = async (deps, { dev }) => { await exec( `npm install --save ${modulesWithPrefix.join(' ')}`, `Installing Nuxt.js modules`, - 'Succesfully installed opted Nuxt.js modules', + 'Successfully installed the opted Nuxt.js modules', { cwd: templateDir, }, @@ -167,7 +167,7 @@ const addDeps = async (deps, { dev }) => { await exec( `npm install --save-dev ${buildModulesWithPrefix.join(' ')}`, `Installing Nuxt.js buildModules`, - 'Succesfully installed opted Nuxt.js buildModules', + 'Successfully installed the opted Nuxt.js buildModules', { cwd: templateDir, }, diff --git a/src/commands/basic/init.js b/src/commands/basic/init.js index 6ad3b456a..5bcae4d8b 100644 --- a/src/commands/basic/init.js +++ b/src/commands/basic/init.js @@ -204,7 +204,7 @@ const fetchTemplate = async (template) => { }; /** - * Bootstrap a basic MEVN stack based webapp + * Scaffolds a MEVN stack based webapp * * @param {String} appName - Name of the project * @returns {Promise} diff --git a/src/templates/starter-templates/Default/README.md b/src/templates/starter-templates/Default/README.md index 489ae5b47..3f055cb63 100644 --- a/src/templates/starter-templates/Default/README.md +++ b/src/templates/starter-templates/Default/README.md @@ -1,34 +1,3 @@ -# basic +# Default starter template -## Project setup -``` -npm install -``` - -### Compiles and hot-reloads for development -``` -npm run serve -``` - -### Compiles and minifies for production -``` -npm run build -``` - -### Run your tests -``` -npm run test -``` - -### Lints and fixes files -``` -npm run lint -``` - -### Run your unit tests -``` -npm run test:unit -``` - -### Customize configuration -See [Configuration Reference](https://cli.vuejs.org/config/). +[MEVN-CLI](https://github.com/madlabsinc/mevn-cli) \ No newline at end of file diff --git a/src/templates/starter-templates/Default/public/index.html b/src/templates/starter-templates/Default/public/index.html index d1cf29207..0addbb067 100644 --- a/src/templates/starter-templates/Default/public/index.html +++ b/src/templates/starter-templates/Default/public/index.html @@ -5,11 +5,11 @@ - basic + Default template
diff --git a/src/templates/starter-templates/Default/src/views/Home.vue b/src/templates/starter-templates/Default/src/views/Home.vue index 569ae82d4..d37c3d46a 100644 --- a/src/templates/starter-templates/Default/src/views/Home.vue +++ b/src/templates/starter-templates/Default/src/views/Home.vue @@ -1,7 +1,7 @@ diff --git a/src/templates/starter-templates/GraphQL/README.md b/src/templates/starter-templates/GraphQL/README.md index b7b13a7cb..a8639430d 100644 --- a/src/templates/starter-templates/GraphQL/README.md +++ b/src/templates/starter-templates/GraphQL/README.md @@ -1,34 +1,3 @@ -# client +# GraphQL starter template -## Project setup -``` -npm install -``` - -### Compiles and hot-reloads for development -``` -npm run serve -``` - -### Compiles and minifies for production -``` -npm run build -``` - -### Run your tests -``` -npm run test -``` - -### Lints and fixes files -``` -npm run lint -``` - -### Run your unit tests -``` -npm run test:unit -``` - -### Customize configuration -See [Configuration Reference](https://cli.vuejs.org/config/). +[MEVN-CLI](https://github.com/madlabsinc/mevn-cli) \ No newline at end of file diff --git a/src/templates/starter-templates/Nuxt.js/README.md b/src/templates/starter-templates/Nuxt.js/README.md index 25b7ee1a5..7340bc87e 100644 --- a/src/templates/starter-templates/Nuxt.js/README.md +++ b/src/templates/starter-templates/Nuxt.js/README.md @@ -1,20 +1,3 @@ -# Nuxt +# Nuxt.js starter template -## Build Setup - -```bash -# install dependencies -$ npm install - -# serve with hot reload at localhost:3000 -$ npm run dev - -# build for production and launch server -$ npm run build -$ npm run start - -# generate static project -$ npm run generate -``` - -For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org). +[MEVN-CLI](https://github.com/madlabsinc/mevn-cli) \ No newline at end of file diff --git a/src/templates/starter-templates/pwa/README.md b/src/templates/starter-templates/pwa/README.md index b7b13a7cb..c5f1e7e2b 100644 --- a/src/templates/starter-templates/pwa/README.md +++ b/src/templates/starter-templates/pwa/README.md @@ -1,34 +1,3 @@ -# client +# PWA starter template -## Project setup -``` -npm install -``` - -### Compiles and hot-reloads for development -``` -npm run serve -``` - -### Compiles and minifies for production -``` -npm run build -``` - -### Run your tests -``` -npm run test -``` - -### Lints and fixes files -``` -npm run lint -``` - -### Run your unit tests -``` -npm run test:unit -``` - -### Customize configuration -See [Configuration Reference](https://cli.vuejs.org/config/). +[MEVN-CLI](https://github.com/madlabsinc/mevn-cli) \ No newline at end of file