EiEResearch/shineyoureye-javascript

Parliamentary monitoring site for Nigeria # Shine Your Eye (JavaScript) This project is a lightweight parliamentary monitoring site for Nigeria. It uses GoogleSheets data, user-editable data (through prose.io), and static images hosted on `gh-pages`. It doesn't use a database. ## Approach The approach to this project is similar to `shineyoureye-sinatra`: * This is a Node.js application that uses content produced by prose.io that is saved in `shineyoureye-prose`. * The `npm run prose` script pulls this content into a local prose folder. * The `cd api && npm run start` script starts the backend api engine, this engine consolidates different data sources into a REST JSON Api to be consumed by authorized hosts. * the `npm run serve` script starts the frontend website which was designed in Vue.js, producing an updated version of the site Non-technical users can use prose.io to add content to the prose repo. ## Data sources This project uses data from several different sources: * The basic details of current Senators and members of the House of Representatives was generated from a GoogleSheets document. This GoogleSheets data is accessed using the GoogleSheets API. * Boundaries and geographical area information are from a MapIt instance: nigeria.mapit.mysociety.org * The images of politicians referenced by the site are served from GitHub pages: * github.com ## Development If you want to contribute to this project, please read our contributing guidelines. ## How to use this project This is a Node.js, Express and Vue.Js project. The Express framework handles the web services that exposes Politicians data, places and boundaries data and Admin editable contents. ## Running the project ### Setting up Express.js 1. Open a new terminal, go to project location and change directory to the folder `api`, you would type: ```cd api``` 2. Then install the necessary dependencies, you would type: ```npm install``` 3. If installation is successful, you would pull in …