https://github.com/raisely/parkes
Framework for RESTful API's on node
https://github.com/raisely/parkes
Last synced: 4 months ago
JSON representation
Framework for RESTful API's on node
- Host: GitHub
- URL: https://github.com/raisely/parkes
- Owner: raisely
- Created: 2017-11-03T00:42:16.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-11-03T01:32:52.000Z (over 7 years ago)
- Last Synced: 2025-01-13T09:36:16.542Z (5 months ago)
- Size: 1000 Bytes
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Framework for RESTful API's on node
(The Parkes Radio Telescope in Parkes, NSW. Image from [Wikipedia](https://en.wikipedia.org/wiki/File:ParkesTelescopeNight.png), 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](http://toddfredrich.com/ids-in-rest-api.html))
* 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](https://github.com/koajs/koa) and [sequelize](https://docs.sequelizejs.com) and requires at least node 7.6
```bash
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