Giter Club home page Giter Club logo

alumni-app's Introduction

WDI SG Alumni Gallery : JavaScript Frontend Framework Challenge

Requirements

You will be building a SPA, that means you will have only one HTML page, and all HTTP requests should be made using AJAX.

To start you need to retrieve the following JSON file, which contains a list of all alumni & students, including their Github names, individual project repository names and links to their deployed applications.

https://raw.githubusercontent.com/wdi-sg/alumni/master/data.json

Using the githubLogin and the repoName of the various projects, you will be able to fetch additional information from the public Github API, examples below:

Github API Examples

  • https://api.github.com/users/jeremiahalex will return details about the user named jeremiahalex
  • https://api.github.com/repos/wdi-sg/peanuts-api will return details about the repo named peanuts-api owned by the user/org wdi-sg
  • https://api.github.com/repos/wdi-sg/peanuts-api/readme will return the readme details for the above project. You'll probably want to grab the download_url to get the raw file e.g. https://raw.githubusercontent.com/wdi-sg/peanuts-api/master/README.md
  • https://api.github.com/repos/wdi-sg/peanuts-api/contents/index.js will return the file details for the file index.js in the project, again you probabaly want to grab the download_url to get the raw file.

Phase 1

A user should be able to:

  • see a list of all WDI SG Alumni & Students, including name, avatar, bio, github link and blog link (if present)
  • a card based display would be nice e.g. https://v4-alpha.getbootstrap.com/components/card/
  • click on a student to see a list of their individual projects including clickable links to the Github Repo & Deployed App for each

Phase 2

A user should be able to:

  • see a list of all projects based upon a project filter (e.g. project3), with a project image displayed (if present else the user's avatar) - it should avoid duplicates for collaborative projects
  • click on a project to view the README file for the that project

Phase 3

A user should be able to:

  • filter the students or projects list based upon course batch (e.g. batch 7)

Phase 4 (Bonus)

A user should be able to save their favourite projects. This will require either a custom API to be made complete with sign-up, signin and registration; or integration with the Github OAuth Authentcation, so the user can signin with Github and star their faviourite repositories.

alumni-app's People

Contributors

sharanvkaur avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.