batuzav/backend-readme-example.md

## backend-readme-example.md

      
    Raw
  

              backend-readme-example.md
            
          
    ...[backend server nombre]...

Este es el back-end del sistema de [Nombre].
Acá se conecta la LINK y el LINK.
Contenido

Back-End controlador de usuraio y notocias.
El proyecto esta realizado en:


Node.js


express.js


GraphQL


MongoDB
ESTE ES UN SERVIDOR NO VISUAL


Programas necesarios

Para poder utilizar el proyecto en localhost en necesario clonarlo y tener algunos programas necesarios:

Nodejs v12.18.0 o Superior.
IDE de desarrollo de tu comodidad Ej. VS Code
PostMan para puebas de APIS. (Opcional)
Git para poder gestionar las versiones.

Como Clonar

Comando para clonar:
cd existing_folder
git clone [LINK DEL REPOSITORIO]

Intalación

Ya clonado el proyecto es necesario instalar todas las dependencias con el comando:
npm install
Run en LocalHost:


Cambiar las llaves a modo pruebas en el archivo config.js

Cuando las llaves esten en modo pruebas ejecutar el comando:
npm test
Este a su vez ejecutara nodemon app.js, el cual ayudará a la funcionalidad de pruebas y dev.
Run en Producción:


Cambiar las llaves a modo producción en el archivo config.js

Cuando las llaves esten en modo producción ejecutar el comando:
npm start
Este a su vez ejecutará el comando node app.js el cual estará preparado para la ejecución del servidor en producción
Subir cambios

Para poder subir cambios al repositorio es necesario utilizar los siguientes comandos.
git add . o si lo prefiere git add "./direction_file"
git commit -m "tu mensaje"
git push origin master
o si usted se encuentra en otro branch
git push origin "your_branch"
##Como hacer un buen commit
Cada cada commit deberá de llevar alguna bandersa que distinga lo que se realizo en el commit. Debe utilizarse las siguientes banderas.
Es recomendado utilizar un icono como referencia visual de la bandera que se esa utilizando.
Ejemplo de banderas.

f.-  feat: Ha añadido una nueva freature (modulo, o la salida completa de una característica)
F.-  fix: Ha realizado un cambio que repará un Bug
d.-  docs: Ha realizado cambios en la
s.-  style: Ha realizado cambios que representen estilos
r.-  refactor:Ha realizado cambios de codigo que no corrigieron ningún Bug o añadieron una feature
t.-  test:  Todo a aquel cambio que sea modo de prueba
c.-  chore: Ha actualizado un tarea contruida previamneto, configuracion en el package manager, etc.

Ejemplos de iconos:
- ➕ `:heavy_plus_sign:` Cuando se añade un archivo o se implementa un feature
- 🔨 `:hammer:` Cuando se soluciona un Bug o un Issue 
- 💚 `:green_heart:` Cuando se mejora un codigo o comentarios
- ⚡ `:zap`` Cuando se mejora el rendimiento 
- 📜 `:scroll:` Cuando se actualiza documentos o el readme
- 🔑 `:key:` Cuando se trata de un cambio relacionado con la seguridad
- 🔁 `:repeat:` Cuando se actualizan dependencias
- ✅ `:white_check_mark:` Cuando un nuevo feature se implementa con exito a producción
- ❌ `:x:` Cuando se esta eliminando codigo o archivos. 
- 🎉 `:tada:` commit inicial o terminacion de un grupo de modulo completo o una version nueva 
- 🚧 `:construction:` cuando se esta contruyendo un feature o una tarea
- 🚀 `:rocket:` cuando se implementa un nuevo feature o tarea. 

Ejemplo:
git commit -m "[:heavy_plus_sign:] r.- add a UserResolver to. [:rocket:] f.- create a function createUser to use in graphQL"
Autor

Desarrollo realizado por BATUZAV