yuem-cli v1.0.5

Yuem-cli-2.0

Command-Line Interface.

Install: npm i -g yuem-cli

What is it?

Yuem is a project that focuses on generating a generic Node.js project, where its main goal is time optimization for creating small projects, using the latest versions of ecmascript 6 with the help of babel, which is a free and open source JavaScript transcompiler that is mainly used to convert ECMAScript 2016+ code into a backwards compatible JavaScript version that can run older JavaScript engines.

The project generates the option of frontend creation using template engines such as pug, hanblebars and ejs as well as pure HTM5 and a node.js backend.

node.js program execution

The program execution is executed with the following commands:

1. Routing to the project folder: cd Name_assigned_to_the_folder.

2. Server execution; for this one of the following commands can be used:

• npm run start, command with which the test environment is executed with the use of nodemon, package that monitors the changes in the source code being developed and automatically restart the server.
• npm run serve`, command that runs the test environment.
• npm run build`, command that executes the transpilation of the project to the current javascript language, keeping the service modern.
• npm run clean`, command that allows to delete the current dist folder, to replace it with the new one generated by the current command.
• npm run start npm run start, command that runs the distribution folder.

IMPORTANT NOTE:

Remember that at the moment of loading in a code version control program, in this case GITHUB, it is important to place in the .gitignore file the following line: ./src/private/*.json and ./src/security/*.json.

¿Que es?

Yuem es un proyecto que se enfoca en generar un proyecto generico de Node.js, en donde su principal objetico es la optimizacion de tiempo para la creacion de pequeños proyectos, utilizando las ultimas versiones de ecmascript 6 con la ayuda de babel, el cual es un transcompilador de JavaScript gratuito y de código abierto que se utiliza principalmente para convertir el código ECMAScript 2015+ en una versión de JavaScript compatible con versiones anteriores que pueden ejecutar los motores JavaScript más antiguos.

El proyecto genera la opcion de creación de frontend usando motores de plantillas como lo son pug, hanblebars y ejs al igual que HTM5 puro y un backend de node.js.

Ejecución del programa node.js

La ejecución del programa se ejecuta con los siguientes comandos:

1. Enrutamiento a la carpeta del proyecto: cd Nombre_asiganado_a_la_carpeta.

2. Ejecución del servidor; para esto se puede usar uno de los siguientes comandos:

• npm run start, comando con el cual se ejecuta el ambiente de pruebas con el uso de nodemon, paquete que monitorea los cambios en el código fuente que se esta desarrollando y automáticamente re inicia el servidor.
• npm run serve, comando que ejecuta el ambiente de pruebas.
• npm run build, comando que ejecuta la transpilación del proyecto a el lenguaje de javascript actual, manteniendo el servicio moderno.
• npm run clean, cmando que permite eleminar la carpeta dist actual, para reemplazar por la nueva generada por el comando actual.
• npm run start, comando que ejecuta la capeta de distribución

NOTA IMPORTANTE:

Recuerda que al momento de cargar en un programa de control de versiones de codigo, en este caso GITHUB, es importan colocar en el archivo .gitignore la siguiente linea: ./src/private/*.json y ./src/security/*.json.

What is necessary to have installed to use YUEM-CLI?

Yuem, being a project designed to save time in the creation of a REST API type project in nodejs, it is necessary to have the following programs installed:

1. Nodejs, which can be installed from https://nodejs.org/es/.
2. MongoDb, which can be installed from https://docs.mongodb.com/manual/administration/install-community/

How to use YUEM:

yuem, consists of different directories which have different functionalities which are:

1. .babel.rc is the file that allows you to run the node.js program with the latest EcmaScript6+ features.
2. .gitignore, file where the exceptions of files or folders to be uploaded to the version control are established.
3. src, root directory of the project, which contains the different directories and the main file.
4. common, contains message files which can be the server errors or data that can be passed constantly to the HTML files.
5. Config has configuration files in the form of function, in that case the connection of the database which is mongo db, has the url and users.
6. Controller, has the function files that are used in the HTTP requests of the routes, they can be different files depending on the necessities and order of the code.
7. Database has the start file of the different databases.
8. Helpers has help or reusable files, in this case it has two sub directories that are rules and key in which respectively fucniones are housed, in this case there are functions of user authentication, as well as the controller.js file has the file jwt.function.js which has the functionality of CRUD and authentication of a user.
9. Lib has system startup files.
10. Mail has configurations to be able to use with the sending of electronic mail.
11. Model is a folder destined to contain the different models or interfaces or schemas of the data to be stored in the databases.
12. Private, has files of type Json, which are files that are of type proven and cannot be visualized in a deploy or a commit of a program of code versioning.
13. Public has the functionalities of public files such as images, css, among others.
14. Routes, has the configuration file of the routes to use in the program.
15. Security has the files of security of the protecto, in that case the secret word of the encryption of the passwords with JWT.
16. Views, has the HTML files to render.
17. Index.js, is the startup file of the program.

¿Que es necesario tener instalado para el uso de YUEM-CLI?

Yuem, al ser un proyecto pensado en ahorrar tiempo en una creación de un proyecto de tipo API REST en nodejs, es necesario tener instalado los siguientes programas:

1. Nodejs, el cual se puede instalar de https://nodejs.org/es/
2. MongoDb, el cual se puede instalar de https://docs.mongodb.com/manual/administration/install-community/

Como usar YUEM:

yuem, consta de diferentes directorios los cuales poseen diferentes funcionalidades los cuales son:

1. .babel.rc es el archivo que permite ejecutar el programa de node.js con las ultimas funcionalidades de EcmaScript6 +.
2. .gitignore, archivo donde se establecen las excepciones de archivos o carpetas a subir al control de verisiones
3. src directorio raiz del proyecto, el cual contiene los diferentes directorios y el archivo principal.
4. common, contine archivos de mensajes los cuales pueden ser los errores del servidor o datos que se pueden pasar de forma constante a los archivos HTML.
5. Config posee archivos de configuracion en forma de funcion, en ese caso la conexión de la base de datos la cual es mongo db, posee las url y usarios.
6. Controller, posee los archivos de funciones que se usan en las peticiones HTTP de las rutas, pueden ser diferentes archivos dependiendo de las necesides y orden del codigo.
7. Database posee el archivo de aranque de la o las diferentes bases de datos.
8. Helpers posee archivos de ayuda o reusables, en este casoposee dos sub directorios que son rules y key en los cuales respectivamente se alojan fucniones, en este caso se encuentran funciones de autenticacion de usuarios, al igual que el carchivo de controller.js se tiene el archivo jwt.function.js el cual posee la funcionalidad de CRUD y autenticación de un usuario.
9. Lib posee archivos de aranque del sistema.
10. Mail posee configuraciones para poder usar con el envio de correo electronico.
11. Model es una carpeta destinada a contener los diferentes modelos o interfaces o esquemas de los datos a almacenar en las bases de datos.
12. Private, posee archivos de tipo Json, los cuales son archivos que son de tipo provado y no se pueden visualizar en un deploy o un un commit de un programa de versionamiento de codigo.
13. Public posee las funcionalidades de archivos publicos como lo son imágenes, css, entre otros.
14. Routes, posee el archivo de configuracion de las rutas a usar en el programa.
15. Security posee los archivos de seguridad del protecto, en ese caso la palabra secreta del cifrado de las contraseñas con JWT.
16. Views, posee los archivos HTML a renderixar
17. Index.js, es el archivo de arranque del programa.

Project created by Juanamhecha9