Skip to content

startup-systems/mashup

Repository files navigation

Mashup project

This project is open-ended!

Requirements

  • Build a site that uses data from at least one external API in an interesting, interactive way. (80%)
  • HTML validation (using the Nu HTML Checker) must pass. (10%)
  • JavaScript linting (using the configured JSHint) must pass. (10%)
  • Replace this README with a description of the project.

Extra credit

Too easy?

  • Build in an object-oriented way (10%)
  • Add fancy interactivity/animations (10%)

If you do either of these, please let Aidan know so he can take a look.

Tips

  • The JS code should be non-trivial. That being said... start simple! (Just get the data to show up on the page.)
  • No server-side coding is required, but feel free to create a backend in whatever language if you like, if you need one.
  • You are welcome to use any 3rd-party libraries/frameworks – just load them from a CDN (e.g. cdnjs), or put them under the vendor/ folder.
  • Do not commit the client_secret (or anything else from an API that says "token" or "secret"), as a hacker could use this to make requests on behalf of you.

Finding an API

A couple things to look for in an API (or at least the endpoints you're using) for this project:

  • Make sure it doesn't require authentication/authorization (e.g. OAuth) - at least for the endpoints that you want to use - so that you don't need a server.
  • If the API doesn't support cross-domain requests (JSONP or CORS), you will need to use JSONProxy.

Here is a list of API suggestions.

Running tests locally

Within this repository directory in your virtual machine:

  1. Install Node.js 6.x.

  2. Install the project dependencies.

    npm install
  3. Run the tests.

    npm test -s

Releases

No releases published

Packages

No packages published