diff --git a/README.md b/README.md index ea283d2..8501e40 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,32 @@ # Mashup project -This project is open-ended! Requirements: +This project is open-ended! -* Build a site that uses data from at least one external API in an interesting, interactive way. +* [AJAX demos](https://github.com/advanced-js/deck/tree/gh-pages/demos/ajax) +* [inspiration?](http://www.programmableweb.com/mashups) + +## 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](https://validator.w3.org/nu/)) must pass. (**10%**) +* JavaScript linting (using the configured [JSHint](http://jshint.com/about/)) must pass. (**10%**) * Replace this README with a description of the project. -* You are welcome to use any 3rd-party libraries/frameworks – just load them from a CDN (e.g. [cdnjs](http://cdnjs.com)), or put them under the [`vendor/`](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. -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. +### Extra credit -* [AJAX demos](https://github.com/advanced-js/deck/tree/gh-pages/demos/ajax) -* [inspiration?](http://www.programmableweb.com/mashups) +Too easy? + +* Build in an [object-oriented](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Introduction_to_Object-Oriented_JavaScript) 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](http://cdnjs.com)), or put them under the [`vendor/`](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 @@ -21,11 +37,6 @@ A couple things to look for in an API (or at least the endpoints you're using) f Here is a [list of API suggestions](https://gist.github.com/afeld/4952991). -## Too easy? - -* build in an object-oriented way -* add fancy interactivity/animations - ## Running tests locally Within this repository directory in your [virtual machine](https://github.com/startup-systems/vm): diff --git a/ajax_text.txt b/ajax_text.txt new file mode 100644 index 0000000..d1d81ed --- /dev/null +++ b/ajax_text.txt @@ -0,0 +1 @@ +

Image editing, courtesy of Aviary. Try editing snother image

diff --git a/index.html b/index.html index 6524157..7b7d96d 100644 --- a/index.html +++ b/index.html @@ -1,8 +1,51 @@ - - Mashup - - - + + Mashup + + + + + + + + +
+ + + Your image +
+