Giter Club home page Giter Club logo

data-persistence-sample's Introduction

data-persistence-sample

This is a sample service that accepts data over a REST API and persists/retrieves it using MongoDB.

BUILD & USAGE

The nodejs service runs by default on port 80. To overwrite for local usage, set the env var

The Following Environment Variables Must Be Set

  • MONGO_DB_CONNECTION_STRING - A valid mongodb URI pointing at a running MongoDB instance. Example: mongodb://192.168.1.100:27017/sample
  • [OPTIONAL] PORT - A valid port number to run the service on. Defaults to 80.

Building & Running Locally

Requires the following: Node 10, MongoDB 4.x

from src dir (where package.json exists), Run the following:

npm run build

export MONGO_DB_CONNECTION_STRING=mongodb://SOME_MONGO:27017/sample 
export PORT=8123

npm start

Building & Running Using Docker

From the root dir (where the Dockerfile exists), Run the following:

docker build -t data-persistence-sample .

docker run -it -p 8080:80 -e MONGO_DB_CONNECTION_STRING=mongodb://SOME_MONGO:27017/sample data-persistence-sample

Using The Service

Please refer to the postman collection in the docs folder for quick start.

ROUTES:

[GET] / -> Health Check
[GET] /api/v1/data -> Get the currently persisted data
[POST] /api/v1/data -> Persist data. The content-type header must be set to "application/json". The request body, if a valid JSON object will be persisted.

data-persistence-sample's People

Contributors

vinaykumar2340 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.