Code Monkey home page Code Monkey logo

keenapi's Introduction

KEEN API

This a basic API which adds Authors and Book information. Every book is linked to an Author by reference. The primary storage for this API is MongoDB for data and Node-Cache for caching

Usage

  • git pull or
  • git clone then
  • npm install

Set environment variables

  • MONGO_URI
  • JWT_SK
  • MongoDB_DATABASE
  • NODE_ENV
  • run the app npm start || nodemon start
  • run the migration to add database collections /migrate

Docker installation

  • Install mongodb image if not available
  • Skip MongoDB installation if you plan to use MongoDB Atlas
  • Create a volume for MongoDB docker volume create mongodb
  • Create a volume for MongoDB config docker volume create mongodb_config
  • Create a network for MongoDB docker network create mongodb
  • Download, Install and Run MongoDB image docker run -it --rm -d -v mongodb:/data/db -v mongodb_config:/data/configdb -p 27017:27017 --network mongodb --name mongodb mongo
  • You can also clone this repository and build the docker image locally using the docker file in the repository
  • Pull the image docker pull bregoh/keenapi:ke2020
  • Build the image docker build -t bregoh/keenapi:ke2020
  • Run the docker container docker run -it --rm -d --network mongodb -p 4001:4001 -d bregoh/keenapi:ke2020
  • Run the migration to add database collections /migrate

Entry Point on heroku

Entry

API Documentation

Docs

keenapi's People

Contributors

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