Giter VIP home page Giter VIP logo

loconot's Introduction

Loconot

Available on http://loconot.herokuapp.com

Have you ever used the stars option on Google Maps? This awesome feature is provided by Google directly into Maps and let users put some stars on their favorites places over the world. Unfortunately it's currently impossible to customize this marker, by adding comments or notes. Then I decided to implement this feature by playing around with Backbone.js.

Loconot web app

Description

The main goal of this project is to get an insight regarding attractives technologies and mainly Backbone.js. This project is my first MV* JS project. It is also a good way to play with an ODM and improving my skills in ruby.

Design

  • Backend/Server: Restfull API - Ruby - Sinatra Framework
  • Frontend/Client: Client - JavaScript - Backbone.js Framework
  • Database: MongoDB

Tools

GoogleMapsApi (v3), TwitterApi, Gulp Require.js, Underscore.js, jQuery, Handlebars, Less.

Requirements

  • Ruby >1.9
  • MongoDb
  • Nodejs 0.10.x

This app requiere a Twitter application to login. You need to create an app on https://dev.twitter.com/. If you want to get a temporary one drop me a line.

Installation

First, clone this project.

Installation on MacOsX

Ruby bundler

$ sudo gem install bundler

Nodejs

Using brew:

$ brew install node

Install MongoDb and run MongoDb.

Twitter App credentials

Add credentials into your environment

#LOCONOT APPLICATION HEROKU ENV
export LOCONOT_TWITTER_CONSUMER_KEY='YOUR_KEY'
export LOCONOT_TWITTER_CONSUMER_SECRET='YOUR_SECRET'

Clone project

To install the backend

$ cd loconot
$ bundle 

Then to install the client use these commands:

$ cd loconot/client
$ npm install 

Running the project

Backend Server

Be sure that MongoDb is running first, then run the Sinatra application:

$ rackup config.ru

Client

$ cd loconot/client
$ gulp

Go to http://localhost:9292 and enjoy!

Deployment

To generate a unique JS file client application you can run the build task

$ cd client
$ gulp build

Then, you can deploy the dist/main.js generated.

loconot's People

Contributors

romain-h avatar

Stargazers

 avatar  avatar

Watchers

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