Git Product home page Git Product logo

parkes's Introduction

Framework for RESTful API's on node

The Parkes Radio Telescope (The Parkes Radio Telescope in Parkes, NSW. Image from Wikipedia, taken by Daniel John Reardon)

Features

  • Just define your database models and you have a simple API
  • Keeps internal DB ids hidden, using a UUID or similar for public IDs (see why)
  • Automatically handles includes and joins for associations
  • Simple definition of public and private attributes
  • Uniform JSON errors
  • Get a working API up in 5 minutes

Getting Started

Parkes is built upon koa2 and sequelize and requires at least node 7.6

npm install -G parkes

# Initialize a new api
parkes init my-api

cd my-api

parkes generate scaffold post
parkes generate scaffold user

# Gives you
# User and Post models
api/models/post.js
api/models/user.js

migrations/create-post.js
migrations/create-user.js

# Database configuration
api/config/database.js

# User and Post controllers
api/v1/controllers/post.js
api/v1/controllers/user.js

# Node server stack
server.js

License

© 2017 Agency Ventures

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.