Giter Club home page Giter Club logo

scale-service's Introduction

Scale Service

Simple back-end service to demonstrate handling queues of background jobs.

GitHub last commit GitHub issues GitHub pull requests GitHub

Instead of having to wait, an id is returned that can be used to query that status of the job.

Get Started

git clone [email protected]:dayvidwhy/scale-service.git
cd scale-service
npm i
npm run start:dev

Development

# Start the dev container
docker compose up --build

# Open a container shell
docker exec -it scale-service bash

Production scaling testing

A docker-compose.yml file is provided to scale the local environment for testing.

Working with docker swarm we can scale up the number of containers and load balance between them.

We can then leverage postman performance testing to do a small scale load test of our service.

# Initiate the swarm
docker swarm init

# build and deploy the app
docker build -t dayvidwhy/scale-service:tag .

# docker stack deploy does not read in the .env file during startup 
# so we instead use another script that executes the necessary command:
# docker stack deploy -c docker-compose-scale.yml scale-service
node deploy.mjs scale-service

# clean up and leave when finished
docker stack rm scale-service
docker swarm leave --force

Adding more modules

Run the following commands replacing [moduleName] with the intended name.

npx @nestjs/cli generate module [moduleName]
npx @nestjs/cli generate service [moduleName]
npx @nestjs/cli generate controller [moduleName]

The new module will be available in ./src/[moduleName].

Test

npm run test
npm run test:e2e
npm run test:cov

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.