University Announcement API

ODU's Announcements, seen here and in the emails, in api form.

Setup

---

Installation

1. Clone the Repo

git clone git@github.com:joshuajharris/university-announcements-api.git
cd university-announcements-api

2. Install Node JS
   • on Mac OSX - brew install node
   • on Windows using chocolatey - choco install nodejs
3. Install dependencies npm install

How to Run

1. In a terminal, in the project directory run node index.js
2. Set environment variables.

export MONGOLAB_URI=enter_your_uri_here # defaults to mongodb://localhost:27017
export HOST=enter_app_host # defaults to http://localhost

If running local mongo instance make a collection called "announcements".

Endpoints

---

/scraper

Scrapes university announcements and presents them in a json object

Author

github: @joshuajharris