Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
app
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

UMD.io · license MIT PRs Welcome CI codecov

UMD.io is an open API for the University of Maryland. The main purpose is to give developers easy access to data to build great applications. In turn, developers can improve the University of Maryland with the things they build.

Features

Easy API access to

  • Four years of course data
  • Live Bus data, through NextBus
  • Campus Building names and locations
  • Information on Professors and Faculty
  • Basic info about all Majors

Getting Started

To use the api, please refer to our documentation.

Development

If you're interested in contributing to UMD.io, please read our Contributing guide. To work on umd.io, or to run your own instance, start by forking and cloning this repo.

Setting Up Your Environment

First, install docker and docker-compose. Then, clone the repo along with the umdio-data submodule.

git clone --recurse-submodules https://github.com/umdio/umdio.git

Then, launch the development environment.

# You may need to run docker-related commands with `sudo` if you're a linux user
docker-compose -f docker-compose-dev.yml up

Once launched, run the scrapers. This will take some time, so in the meantime, review the rest of the guide.

# You may need to run `chmod +x umdio.sh`
./umdio.sh scrape

Credits

See contributors

License

We use the MIT License.

About

An open API for the University of Maryland

Topics

Resources

License

Releases

No releases published

Packages

No packages published

Languages