satiewaltz / reactionary

A serverless RESTful API built for accessing Mark Erikson's react-redux-links collection.

Home Page:https://api.theweb.rocks

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Reactionary API

A serverless RESTful API built for accessing Mark Erikson's react-redux-links collection.

Try it out: curl -l https://api.theweb.rocks/ | python -m json.tool

Endpoints

Collection of all files including some metadata: https://api.theweb.rocks

Resources and links from a single file: https://api.theweb.rocks/:id

ID is a number starting from 1. (Ex. /1 returns the "basic concepts" file.)

Overview

First we grab a URL list of all files fromm the repository with getFileURLs(). It returns an array of URLs that we can use to get data from each files.

Next, we get the raw markdown file from each file in the repo then parse each file into an AST (Abstract Syntax Tree). Passing that into computeAST() will return a cleaned up object of the markdown file that is properly organized into an array of objects containing an entry of each resource:

Sample response from API


Built With

  • Express
  • Serverless | AWS Lambda
  • Webpack

Getting Started

First create a .env file on the top level directory with your GitHub personal access token:

TOKEN=1234567890

Fire up the express server and open http://localhost:3000.

yarn start

Licensing

MIT

Created by Dave Barthly

About

A serverless RESTful API built for accessing Mark Erikson's react-redux-links collection.

https://api.theweb.rocks

License:MIT License


Languages

Language:JavaScript 100.0%