Code Monkey home page Code Monkey logo

cyclocensus's Introduction

CycloStat

A statistic engine to know when to take a bike according to your time.

This repository contains the source code for the search API.

The search api consists in the following main components:

  • Node modules to manage the rest api and to connect with externals modules.
  • A server exposing an API to interact with third-party services and returns sorted search results.

Requirements

  • Node 0.10.x & NPM
  • MongoDB database

Use whatever you want to install them (from source, homebrew, apt).

Usage

Before run

  • Sign up on JCDecaux API Website if you haven't already done so and find your API Key.
  • Add a ".env" file at the root level of the project you fill with API key, and MongoDB username, password, interface and database.
JCDECAUX_API_KEY: [YOUR_API_KEY_HERE]
MONGODB_URI: mongodb://[YOUR_USERNAME]:[YOUR_PASSWORD]@[YOUR_MONGODB_INTERFACE]:45604/[YOUR_DB]
NODE_ENV: development
PORT: 8080
CRON_ENABLED: false

Note: If running your MongoDB in local, use 'mongodb://localhost:27017/test' for MONGODB_URI field switching to test database.

Run

Run the API server:

npm install
npm start

The server should be running on http://localhost:8080. You can change port and apiKey in config.js file.

Stop server

You simply have to use Ctrl-C to stop the server from command line.

Contributing

Everything works around one branch (develop) to follow the Github Flow.

Don't forget to exclude your apiKey from commits

More documentation

cyclocensus's People

Watchers

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