Skip to content

Repository files navigation

>bootenv-REST API

license engine npm Build Status

Prerequisites

You will need the following things properly installed on your computer.

Installation

  • git clone git@github.com:bootenv/bootenv-rest-api.git this repository
  • change into the new directory bootenv-rest-api
  • nvm use
  • npm install -g strongloop
  • npm install

DB Config

The data layer for API is based on MongoDB.

Now, we are not using bootenv to setup our conf variables but we really need migrate as soon as possible!

Running

  • nvm use
  • npm start

Running in development

In development mode (NODE_ENV=development) we monitor for any changes and automatically restart the server

  • nvm use
  • npm run serve

Visit your API status at http://localhost:3000. To explore your API visit http://localhost:3000/explorer.

Docker

As we want to run this REST-API in a Docker container, please take a look on a given Dockerfile. The Dockerfile is simple and straightforward.

Running with Docker Compose

The quickest way to get started is using Docker Compose.

docker-compose up

NOTE: Please allow a couple of minutes for the REST-API to start.

Build and Running the Docker Image

Alternately, you can manually build and run the Docker REST-API container.

docker build --tag="bootenv/bootenv-rest-api:latest" .
docker run -d --name api -p 3000:3000 --env='NODE_ENV=development' --env='MONGO_URL=mongodb://localhost:27017' bootenv/bootenv-rest-api:latest

Code Generators

Make use of the many generators for code, try slc --help for more details

Further Reading / Useful Links

Versions

  • 1.0.0-alpha.1 (current)

License

Apache-2.0

About

The bootenv api server

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages