Giter Club home page Giter Club logo

dnbo-api-js's Introduction

DTE-DNBO-API

API allow To integrate both DNBO0.5 & DNBO1.0 in single API on the k8s platform (single EndPoint) which will be used later as a communication interface with DNBO system and all other external/internal systems such as VAS, Snoc, DBSS

API Architecture

Alt text

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

You need to install the fellowing software in order to get the api up and running

  • Node.js and npm
  • Docker
  • Kubernetes on cloud

Development environment

Running node.js api

  • Download or clone the project code from https://github.com/abdm64/DNBO-API-JS

  • Install all required npm packages by running npm install from the command line in the api folder (where the package.json is located).

  • Start the api by running npm start from the command line in the api folder, you should see the message Server listening on port 3000. You can test the api directly using an application such as Postman or you can test it with one of the page web.

Testing environment with Docker

  • Download and install docker in your machine

  • inside the root folder run the fellowing cammand

$docker-compose up 

and now the server live on the port 80 using nginx instance

Docker image

  • Build your own docker image and push it to your repo by running "docker build -t my-app-name:v1 . " from the cammand line in api folder you can push it to your own registy

Production environment

  • Deploying this app on kubernetes system can be so easy by applying the k8s yaml files, make sure that you upload the app image to the docker hub or private registry and change the image name config in dnbo-dep.yaml , then run "sudo kubectl apply -f k8s" from the cammand line in the root folder.

  • PS : you must install NGINX Ingress Controller on your k8s cluster before applying the final deployment please check this link https://kubernetes.github.io/ingress-nginx/deploy/ for more information

Deployment Architecture

Alt text

Deployment Architecture Explaind

in the final deplyment we have two separted application the main api ( dte-dnbo-api ) and the front appliaction to control the main api (not ready yet ) we create ingress service and multiple replicas for the dnbo-api because we expect a large amount of traffic per second ( 1000 req per second )

Author

  • Messelleka Abdellah - *DevOps Engineer @ - Djezzy

License

This project is licensed under the MIT License

Credits

Made with ❤️ by Abdellah

dnbo-api-js's People

Contributors

abdm64 avatar

Watchers

 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.