loicpirez / hyperdia-api

API to request Hyperdia service. (autocompletion, and transport schedules)

hyperdia-api

API for Hyperdia service.

About

Warning ! It's still under development. Only autocomplete route is implemented. Documentation and usage will be in this README when search feature will be done.

This project uses Feathers. An open source web framework for building modern real-time applications.

Getting Started

Getting up and running is as easy as 1, 2, 3.

1. Make sure you have NodeJS and npm installed.

2. Install your dependencies

   cd path/to/hyperdia-api; npm install
   

3. Start your app

   npm start
   

Testing

Simply run npm test and all your tests in the test/ directory will be run.

Scaffolding

Feathers has a powerful command line interface. Here are a few things it can do:

$ npm install -g @feathersjs/cli          # Install Feathers CLI

$ feathers generate service               # Generate a new Service
$ feathers generate hook                  # Generate a new Hook
$ feathers generate model                 # Generate a new Model
$ feathers help                           # Show all commands

Help

For more information on all the things you can do with Feathers visit docs.feathersjs.com.

Changelog

0.1.0

• Initial release

License

Copyright (c) 2018

Licensed under the MIT license.