🔥JC's JS Tips API🔥
This API scrapes twitter to get the latest exercises from JC's profile.
Overview
The API is currently built on express and exposes a single GET endpoint: /jcs-js-tips.
The data is curated by using a combination of the following:
- axios: To fetch the HTML from the page
- cheerio: Traverse the retrieved HTML (similar to jQuery)
- date-fns: Simple date parser/formatter
Going Forward
Next items to consider:
- endpoints: I've had a few thoughts on this.
- hosting: Currently hosted on Heroku
- data storage: As the list grows, scraping from Twitter becomes expensive overhead. Ideally, we'd want to store this in a DB of sorts and retrive on request.
- community impact: The point of JC taking the time create these challenges, is to promote learning in the open. As such, I'd like this API to stick to that value and offer sensible solutions that find the right balance of robustness and ease-of-entry.
Contributing
🚨PR's, issues, and suggestions are welcome to all skill levels!🚨
I was really looking forward to pushing this to a final form. However, I'm finding myself too busy to take on the task as soon as I would like (exciting news on the horizon!), so I'm looking for the community to step in.
This is a great way to get involved in the community and to dive into open source 🤓
Setting up the project
- fork this repo and clone your copy to your computer
cd into the project's directory- run
npm install to install the dependencies
- run
npm start to start the development server
- navigate your browser to the endpoint:
/jcs-js-tips