Git Product home page Git Product logo

kogi-widget-fullstack's Introduction

Kogi Widget Fullstack

This is the fullstack implementation of a simple login widget. The back end is a Node.js server built with express that serves static assets as well as providing proxy API calls. The front end was built with Yeoman and simply renders the content of the widget.

What You Need

This project depends on several pieces of software available for free.

Getting Started

After installing the dependencies above, we can now prepare our back and front end.

Front End Prep
$ cd /path/to/repo/widget-client
$ bower install
$ npm install
Back End Prep
$ cd /path/to/repo/widget-server
$ npm install

Thats it! You're ready to start coding!

Running the code

First start the back end

$ cd /path/to/repo/widget-server
$ grunt serve

Then serve the client

$ cd /path/to/repo/widget-client
$ grunt serve

Making Changes

The front end portion of this project doesn't need to be modified unless you want to play with how the widget will behave in various environments. To edit the widget itself please modify /widget-server/src/static/testwidget.js .

Deploying server to Heroku

Simply ensure all of your server changes are committed. You'll need to create your own heroku app and associate the Gruntfile repo url's with it. As well, make sure you have public key access to that heroku app.

Afterwards, simply run

$ cd /path/to/repo/widget-server
$ grunt deploy

Deploying front end Changes

You shouldn't need to deploy front end changes as modifying the widget should suffice. If you do want to play around with different environments on the front end you can push the changes to the github pages like so

$ cd /path/to/repo/widget-client
$ grunt build
$ grunt buildcontrol:pages
Templates

In order to minimize the amount of HTML to be written in jQuery/Javascript i've circumvented CORS on the server side to allow for rendering of HTML templates. One can simply pull in raw HTML, or Underscore style templates to handle display of complex JSON structures.

The raw HTML is styled with Pure CSS, a lightweight CSS framework. You can leverage any of the components you choose in your HTML and Templates

TODO
  • Create proxy API methods on server side for complete functionality
  • Scaffold out remaining views
  • Adjust styling to spec
  • (Maybe) Implement Backbone.js for model relations
  • UNIT TESTING
  • Shell script to start everything automatically

kogi-widget-fullstack's People

Contributors

msandt3 avatar

Watchers

 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.