Git Product home page Git Product logo

crawler.js's Introduction

Component Crawler

http://component-crawler.herokuapp.com/

Crawl github users for components. Only works with Chrome right now due to a lack of vendor prefixing.

Some notes:

  • It skips component.jsons with private: true.
  • It skips repositories with issues disabled.
  • It tries to skip bare repositories, but sometimes fails.
  • The .version could be wrong if not updated correctly (the crawler only checks master).
  • GitHub data is added as .github to each component.json.
  • Watcher counts are not included because GitHub's search API does not include that field.

API

GET /.json

Returns an object:

  • users - an object of all the users crawled.
  • components - array of component.jsons.

GET /log

Return an event source stream of updates.

GET /:user

Return all a user's components.

PATCH /:user

Update all the components of a user.

GET /:user/:repo

Return a repo's component.json.

Development

Setup

  • create an AWS S3 bucket in the US Standard region
  • create an AWS IAM user
    • copy the ACCESS KEY and the SECRET
    • apply the AmazonS3FullAccess policy to the user
  • run these commands in your terminal:
export S3_KEY='<YOUR_KEY>'
export S3_SECRET='<YOUR_SECRET>'
export S3_BUCKET='<YOUR_BUCKET_NAME>'

Test

npm test

Start the app

npm start then open localhost:3000 in your browser. At the localhost:3000/ you can type in a github username or organisation at the bottom and after a while you can see the result at localhost:3000/.json

License

The MIT License (MIT)

Copyright (c) 2014 Jonathan Ong [email protected]

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.

crawler.js's People

Contributors

jonathanong avatar timaschew avatar deepak1556 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.