Generator-Yuna

Universal generator(🌎) for all preliminary and advanced projects (batteries included)

Table of contents

• spell it

• Install

• Usage

• why yuna

• features included

• Assumptions

  • Database

• Apps inspired yuna

• License

Spell It

yu-na -> spell ass yo-na not you-na. Yeoman Universal generator (YUNA). (it is a requirement of yeoman ecosystem to include generator prefix)

Install

Yuna requires several tools as dependancies listed in assumptions.

npm install -g yeoman
npm install -g generator-yuna

Usage

before running yuna, please make sure that the deployment folder is created with the name which will be giving to the application

yo yuna

Why yuna?

The first impression get when a person reach Yuna is why another generator ? The main idea behind yuna is to make it more simpler and less fuzzie generator at all. If you consider more advanced tools, what can observer is complexity. herewith yuna, brings more simpler and robust scaffolding system.

There are more general webapp scaffolding apps listed on (Yeoman site) yeoman-generators, you can find on visiting the site.

Here are features included in yuna script.

features included

• programatic, prioritized, and intelligent dependancy mangement to the generated project
• comprehensive
• Exetendable
• important tools included (gulp, sass, babel, postcss, browser-sync, sourcemaps, eslint, etc.)
• git configuration included and pre configured.
• minimal server side PHP scripts included with security hardened (more languages will be supported in the future ex: js, ruby, java)
• support to multiple builders and bundlers (gulp, rollup)
• depoloy script included to support local deployment (deploy.bat) using *AMP stack (windows only)

visit docs for more

Assumptions

• The plugin runs on windows (because of deploy.bat)
• MYSQL database client installed and configured
• Local dev server is WAMP
• Nodejs and git installed and configured
• SERVER_ROOT env is set to point to local deploy location

Database

yuna assumes MySQL database client was installed and below enironment variables configured.

• MYSQL_DATABASE to point to database name
• MYSQL_USER to point to current database client user
• MYSQL_PASSWORD listing the user password

(please feel free to change the respective envars according to the client used to develop the application)

Apps which inspired to create yuna

making of Yuna inspired by 2 of the most amazing repos available on github 😎 generator-webapp generator-union-webapp

License

MIT

© contact me