Your objective is to learn your chosen JavaScript frontend framework and use it to build a Single Page App (SPA) that connects to the Github API and displays a list of WDI SG alumni, students, and their projects. The requirements are given below.
You will implement this project independently but you will be learning your front-end framework in groups. Each group will be lead by a member of the Instructional Team, who will take the role of the Senior Developer. This is an opportunity for you too see what it will be like to learn on the job as part of a team. It is recommended that you setup a Slack Channel to communicate, and a Trello board to share resources.
The development of the project should be approached in phases, details of which are below.
Note. The emphasis is on learning the framework, so focus on understanding (i.e. don't implement anything you don't understand).
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
The results will look like so:
[
{
"batch": "0",
"githubLogin": "jeremiahalex",
"project1": {
"repoName": "project-1",
"deployedUrl": "http://jeremiah.sg",
"previewImage": "http://some-cdn.link/image.gif"
},
"project2": {
"repoName": "project-2",
"deployedUrl": "http://jeremiah.sg"
},
"project3": {
"repoName": "project-3",
"deployedUrl": "http://jeremiah.sg",
"collaborators": ["nickangtc", "terencelimsayjian"]
},
"project4": {
"repoName": "project-4",
"deployedUrl": "http://jeremiah.sg"
}
}
]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/jeremiahalexwill return details about the user named jeremiahalexhttps://api.github.com/repos/wdi-sg/peanuts-apiwill return details about the repo named peanuts-api owned by the user/org wdi-sghttps://api.github.com/repos/wdi-sg/peanuts-api/readmewill 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.mdhttps://api.github.com/repos/wdi-sg/peanuts-api/contents/index.jswill 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.
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
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
A user should be able to:
- filter the students or projects list based upon course batch (e.g. batch 7)
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.
Each Group (excluding Instructional Team Members) will teach a half-day class on the framework. It should include
- the philosophy of the framework
- it's strengths and weaknesses
- A getting started code along (optionally with a markdown file that can be followed and later added to the Gitbook)
- a demo/demos of the challenge solution