https://github.com/s-taylor/kickcomment

https://github.com/s-taylor/kickcomment

aws-lambda kickstarter rss

Last synced: 14 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/s-taylor/kickcomment
• Owner: s-taylor
• Created: 2017-02-15T21:34:59.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-06-29T21:02:52.000Z (over 7 years ago)
• Last Synced: 2024-11-11T18:40:32.345Z (2 months ago)
• Topics: aws-lambda, kickstarter, rss
• Language: JavaScript
• Size: 991 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Kick(starter) Comment API

## Objective

This project is aiming to implement a kickstarter comment search engine. Currently there is no feature to facilitate searching kickstarter comments, this makes it difficult to know whether a question has already been asked before, or search for comments from a particular user. Furthermore, only 50 comments are shown on a page at a time meaning if you want to search all comments using the browser's find, you first need to click the Load More Comments button many many times to load all the comments.

## Solution

* Implement an API that can scrape all of the comments for a particular project

* Provide the ability to search through these comments using a given keyword or username

Finally a basic front end UI will need to be built to facilitate searching. This will be done under a separate repo once the API is built.

## Hosting

I'm using this as an oppurtunity to also learn AWS Lambda as it is the perfect candidate as an API to scrape comments adhoc (as requested by the user), so the Lamdba configuration (using the Serverless framework) will be included in the repo. This means if you want to deploy this, install [Serverless](https://github.com/serverless/serverless) on your machine and run the deploy command (see package.json).

- - -

## To do List

In approximate order of priority...

* Refactor endpoint to make id and name params rather than query string options since they're mandatory.

* Cache comments in a database using the `id`. Then if after a request is made to kickstarter the results contain 1 or more comments that are already cached, you know that the rest of the comments have already been fetched which can then be used to avoid making any further requests to kickstarter.

* Implement the ability to search comments (passing a query string)