GithubHelp home page GithubHelp logo

mascotas_node's Introduction

Mascotas

Backend en node para el proyecto mascotas

Abrir ventana de comandos en el folder node y ejecutar :

npm install
npm start

El backend expone la documentación de las api abriendo localhost:3000

Documentación de API

Entorno de Desarrollo

El proyecto se desarrollo con Visual Studio Code, Si bien podrían utilizarse alternativas como Atom, Sublime.

Algunos plugins interesantes para VSCode que facilitan el desarrollo :

  • JavasScript (ES6) code snippets by charlampos karypidis
  • ESLint by egamma
  • Typescript React code snippets
  • React Native Tools
  • ES7 React/Redux/GraphQL/React-native snippets

Existe un Workspace configurado para VSCode en la raíz del proyecto :

Microservicios.code-workspace

Dependencias

MongoDB

Es la base de datos principal.

Seguir las guías de instalación Mascotas

Redis

Redis es una segunda opción de almacenamiento de datos. Para almacenamiento de imágenes hace uso de Redis.

Ver la guía en la pagina del proyecto : Mascotas

Node 12+

Seguir los pasos de instalación del sitio oficial nodejs.org

Ejecución

Abrir ventana de comandos en la carpeta del microservicio y ejecutar :

npm install
npm start

Archivo .env

Este archivo permite configurar diversas variables de entorno de la app, ver ejemplos en .env.example

Todas estas variable pueden definirse como variables de entorno del sistema operativo también.

Apidoc

Apidoc es una herramienta que genera documentación de apis para proyectos node (ver Apidoc).

El microservicio muestra la documentación como archivos estáticos si se abre en un browser la raíz del servidor localhost:3000

Ademas se genera la documentación en formato markdown.

Docker

Esta es una version de docker para producción :

docker build --no-cache -t mascotas-node https://raw.githubusercontent.com/nmarsollier/mascotas_node/master/Dockerfile

# Mac || Windows
docker run -it -d --name mascotas-node -p 3000:3000 mascotas-node

# Linux
docker run --add-host host.docker.internal:172.17.0.1 -it -d --name mascotas-node -p 3000:3000 mascotas-node

Test

mascotas_node's People

Contributors

nmarsollier avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.