Skip to content

chukaofili/simple-api

Repository files navigation

Simple API

API for Simple App.

Installation

These instructions are for use without docker

  • Make sure that Node.js is installed.
  • Install Node.js modules with npm:
npm install

Starting App

  • To run the app, copy the file config/env/development.js to config/local.js and substitute the settings to match your develoment environment.
  • Start the app with npm:
npm start
  • Navigate to localhost:1500. Please note 1500 is the default port used, you can change this in config/local.js or the corresponding enviroment file in config/env depending on your NODE_ENV os eniroment variable.

Testing

  • Tests are written using the Mocha.js library.
  • To run tests with npm use:
npm test

Docker

Using Kubernetes - Minikube

  • Make sure that Minikube (Local kubernetes installtion) is setup & configured.
  • Also install the nginx minikube controller if you havent already. You can deploy a copy using kubectl create -f ./deployment/deployments/ingress/nginx-minikube/
  • Install and setup dnsmasq, and point your minikube installation IP to *.vm:
  • Setup secrets found in deployment/deployments/deployment.yaml
  • Run in the follwing order:
kubectl create ns develoment
sh ./deployment/deploy.sh dev

Visit App

About

Simple NodeJS API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published