Giter VIP home page Giter VIP logo

pens-boilerplate's Introduction

PENS Stack Boilerplate

This repository gives you a simple boilerplate for rapidly developing an application using the PENS stack (nobody calls it that but me).

PENS:

  • Polymer (client-side framework)
  • Epilogue & Express (routing frameworks)
  • Node (server)
  • Sequelize (data access)

Installing

This will be links later

  • download node, git, npm and bower
  • clone this repository
  • run npm install and bower install
  • start hacking!

Running

  • run npm run start

Creating a new Model and exposing Resource

Sequelize and Epilogue team up to make creating routes super easy.

  • Create a model in it's own file in db/models example:
   //db/models/post.js 
   module.exports = function (sequelize, DataTypes) {
   var Post = sequelize.define("Post", {
     text: DataTypes.STRING,
     title: DataTypes.STRING
     }, {
      classMethods: {
        associate: function (models) {
        }
      }
    });
    return Post;
  }
  • Add your resource to api/index.js
  var posts = rest.resource({
      model: db.models.Post,
      endpoints: ['/posts', '/posts/:id'],
  });  
  • Test your application
    • run npm run start
    • use a rest client (eg. POSTman) and interact with /api/posts
    • you should have basic CRUD routes now.

TODO

  • consider a resources folder similar to models which is auto included
  • create generator for model/resource
  • create generator for polymer element
  • tests

pens-boilerplate's People

Watchers

James Cloos avatar Mallory Allen 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.