Skip to content

Latest commit

 

History

History
executable file
·
73 lines (56 loc) · 2.24 KB

README.md

File metadata and controls

executable file
·
73 lines (56 loc) · 2.24 KB

Sleepy API Framework

##Resting Template

A basic template for RESTful Web Services in many popular web languages. With an AngularJS front-end template.

##Web Stacks

######PHP Web Service

  • SLIM PHP Framework
  • MySQL

######NodeJS (MEAN) Web Service

  • ExpressJS Framework
  • Mongo Database

######Python Web Service (Coming Soon)

  • Pyramid Web Framework
  • Neo4j Graph Database

##Main Functionality

  • GET
  • POST
  • PUT
  • DELETE
  • SEARCH

Setup on Mac OSX

#####NodeJS Setup

  1. Open OSX Terminal.
  2. Install Homebrew: ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  3. Update Homebrew: brew update
  4. Install Node: brew install node
  5. Install Express: npm install -g express
  6. Install Mongo: brew install mongodb and brew upgrade mongodb
  7. Create Data Directory: mkdir -p /data/db
  8. Start Mongo Server: mongod
  9. Clone the Repo: git clone git://github.com/leorue/resting-template.git
  10. Enter Node API Directory: cd resting-template/api/node/bin
  11. Start up the server: node www.js
  12. View in browser at http://localhost:8000/api/movies/

#####Python Setup

  • Coming Soon!!

#####PHP and Angular App Setup

  1. Download and Run MAMP or MAMP Pro.
  2. Set Root Directory to the resting-template Directory: Hosts > General > Document Root > Set to resting-template
  3. Set Index permissions: Hosts > Extended > Check: Indexes and Check: SymLinksIfOwnerMatch
  4. Create SQL Database: Load PHPmyAdmin > New > Enter: data > create > SQL Tab > Copy/Paste Cellar.sql > Go
  5. Create New User: Home > Users > Add User > Username: data, Host: localhost, Password: jh43it87 > Global Privilages > Check All > Go
  6. View in browser at http://localhost:8888/api/php/wines/:id
  7. View Project Interface

Next Gen Features to Add

  • Store Image and File Uploads
  • API Authenitcation
  • Update Front-end Design
  • NodeJS API Search Query Function
  • Python RESTful Web Service (Pyramid and Neo4j)

===== If you have any questions or requests, email us at schultz.leo@gmail.com and we'll keep updating this to make it perfect.