Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 2.27 KB

README.md

File metadata and controls

59 lines (39 loc) · 2.27 KB
Raw

Cache middleware application for Edgeryders Discourse API

Mini application writen in NodeJS/Express that retrieves and caches data from Edgeryders Discourse API

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development purposes

Installing

A step by step series of examples that tell you how to get a development env running

# install dependencies - execute the command in project root:
$ npm install

# create .env file at project root
# copy content from .env.example file into .env file 
# provide discourse API key and netlify build hook command
# ensure .env is added to .gitignore

# run app in development mode:
$ npm run dev

# run app in production mode:
$ npm run prod

`

Built With

License

This project is licensed under the MIT License

NOTES

  • This is minimal NodeJS/Express application writen for purposes of retrieving and caching data from Edgeryders Discourse API
  • Runs on port 3001
  • Exposes only one GET endpoint /get-data that accepts endpoint query parameter (pass desired Edgeryders Discourse API endpoint here)
  • Example: http://localhost:3001/get-data?endpoint=https://edgeryders.eu/t/edgeryders-culture-squad/9591
  • It accepts endpoint as query parameter, retrieves data from https://edgeryders.eu/t/edgeryders-culture-squad/9591 in this case, caches it and retrieves data to caller
  • Cache middleware application runs cron job that periodically triggers Netlify build hook that rebuilds website (website is built with Nuxt.js as mentioned already and hosted on Netlify, actually static generated data is hosted on Netlify as it is feature of Nuxt.js, so if change in API data occurs, the site should be rebuilt periodically to generate static files with new data, thus cron job is added)

Example API call from frontend:

async getData() {
    const response = await $axios.get(`http://localhost:3001/get-data?endpoint=https://edgeryders.eu/tags/webcontent-culturessquad-burning`);
    
    return response.data;
}