Giter Club home page Giter Club logo

simple-rest-api's Introduction

Simple REST API

This is an API built using StrongLoop. It relies on NodeJS and MongoDB.

Prerequisites

You will need:

Getting Started

  1. Make sure you have git installed
  2. Install NodeJS and NPM via the provided link (we recommend using the first script).
  3. Install MongoDB using the provided link. Make sure to follow the instructions all the way down the page to AND including "Start (Run) MongodDB". MongoDB must be running in order for the API to run!
  4. If you have not already done so, run npm install -g strongloop.
  5. Now run the following commands:
git clone [email protected]:simpulton/simple-rest-api.git
cd simple-rest-api
npm install
slc run
  • Note: If you want to use the version without authentication, checkout the "without-auth" branch and restart the API if necessary. Be sure to do the same in the simple-rest-website repo.

Alternative - Docker

An alternative way to run the simple-rest-server is via Docker and fig.

git clone [email protected]:simpulton/simple-rest-api.git
cd simple-rest-api
fig up

Navigate to localhost:1337/explorer (or http://192.168.59.103:1337/explorer/ if using boot2docker) to view your api.

Congratulations!

You can now play around with it using the explorer or head over to Simple REST Website for a super-simple front-end application that connects to your new API!

simple-rest-api's People

Contributors

skuenzli avatar jdgarvey avatar

Watchers

James Cloos avatar Jorge S. Sanchez 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.