Code Monkey home page Code Monkey logo

article-search's Introduction

article-search

article-search is a Single Page App that searches the SCPR API (v3) for articles and returns the article titles as well as 10 second clips of any associated audio files.

The api (search-api/) was built on Rails using the --api flag, which avoids most of the frontend views that usually gets generated with Rails' generators. None of those views are necessary in this case since the frontend is all AngularJS.

The client (client/) is an AngularJS app. All app related tasks from testing to running a frontend server to a fullstack server can be done thru gulp tasks.

Dependencies

  • Rails 5
  • Postgres
  • Angular JS
  • ffprobe

Usage

  1. Install Rails:
    $ gem install rails
    
  2. Install npm
  3. Install gulp
    $ npm install --global bower gulp-cli
    
  4. Install required gems (in the search-api/ directory):
    $ bundle install
    
  5. Go to the client/ directory
  6. Install bower dependencies
    $ bower install
    
  7. To run the fullstack app (in the client/ directory):
    $ gulp serve:full-stack
    
  8. To run the rails app (search-api/ directory):
    $ rails s
    
  9. To run backend tests (search-api/ directory):
    $ rspec
    
  10. To run frontend tests (client/ directory):
    $ gulp test
    

Assumptions

  • Audio files returned by SCPR api are in mp3 format.
  • Article ID's are unique

License

The MIT License (MIT) Copyright (c) 2016 Lu Yi Louise Yang

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

article-search's People

Contributors

nakedsushi 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.