Giter VIP home page Giter VIP logo

service-template's Introduction

IMPORTANT

  • this is a base image to help you get started fast, but it should by no means limit your creativitity. Feel free to change any part of it and contribute back to this project if you think it can help others.
  • replace all occurences of myservice in the project with the name of you project
  • Check all the TODO lines and edit/remove/add code accordingly
  • Remove this block once you are done

myservice

TODO: Add a very short description of the microservice

Introduction

TODO: Describe what the service does with more details.

It works as follows:

  • It listens to requests coming through bull's queue myservice-requests.
  • It processes the request
  • It adds a job to the myservice-results queue to let other services (e.g. api) know that the operation finished and share its result.

API

TODO: describe the api of the services including any endpoint or any messages (received or generated).

Integration tests

Running the tests

To run the integration tests, you need:

  • Docker compose
  • To be in the integration tests directory. Use cd <project directory>/test/integration

Now you can launch the tests using the command

docker-compose up

Updating node_modules

As node_modules are part of the container image, you will need to recreate the tests image if you want to update your dependencies.

To do that, please run the following commands:

docker-compose down
docker-compose build
docker-compose up

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.