Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
views
.gitignore
README.md
config.js
index.js
package.json

README.md

University Announcement API

Heroku David
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
  1. Install Node JS
    • on Mac OSX - brew install node
    • on Windows using chocolatey - choco install nodejs
  2. 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

pic