Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kieranmueller/dev-duel
Gag site using github and Cook Systems API to find and duel github users. Built with Angular
https://github.com/kieranmueller/dev-duel
angular api express nodejs typescript
Last synced: about 1 month ago
JSON representation
Gag site using github and Cook Systems API to find and duel github users. Built with Angular
- Host: GitHub
- URL: https://github.com/kieranmueller/dev-duel
- Owner: KieranMueller
- License: mit
- Created: 2023-07-14T16:41:20.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-14T16:53:41.000Z (over 1 year ago)
- Last Synced: 2024-04-20T13:09:11.105Z (9 months ago)
- Topics: angular, api, express, nodejs, typescript
- Language: TypeScript
- Homepage: https://www.youtube.com/watch?v=KGV7CNu7WLw&t=41s
- Size: 322 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://classroom.github.com/online_ide?assignment_repo_id=11448497&assignment_repo_type=AssignmentRepo)
# Angular Dev-Duel
# Assignment Overview
For this assignment, students are tasked with developing a small full-stack application that interfaces with [GitHub's API](https://developer.github.com/v3/) in order to aggregate, transform, and display a given user's profile and repository data.
The assignment is composed of two independent pieces that make up a simple full-stack application.
1. A [Node](https://nodejs.org/en/docs/) **server** exposing an API using [Express](https://expressjs.com/en/api.html)
2. A Web-based **client** using [Angular](https://angular.io)
This specification is split into multiple parts.
- [Assignment Overview](README.md) - Gives a general overview of the assignment and technical requirements
- [Development](DEVELOPMENT.md) - Instructions on setting up development environment and servers
- [Server](server/README.md) - Information specific to Node API implementation
---
## Requirements Overview
Students will implement a web application to communicate with a provided supporting API to get the following data for a given user's GitHub profile. The backend has been implemented as a Node API using Express that will call GitHub's API to fetch data necessary to derive/display the data specified. The user will see a home page where they can choose between two options: **inspect** or **duel**.
## Token setup
In order to increase your rate limit with the GitHub API and improve overall testability of your application as you develop, you will need to create and use a GitHub token. Instructions for this process are included in the [token-setup/README.md](token-setup/README.md).
# Getting Started with the Client
Students will build a client side application using Angular. The app will consist of a Home Page, an Inspect Page, and a Duel Page. Refer to the wireframe below as a basic guideline for the structure.
### Inspect
On the **inspect** page, a client will enter a username, submit, and be displayed the user's `profile` data.
### Duel
For the **duel** page, it is left up to the student to choose how a winner is determined. Two usernames will be entered, submitted, and their `profile` data displayed. Using the fields that are received from the API and displayed to the user, the student will need to visually signify differences in the data displayed as well as make an overall winner apparent to the user.
## Error Handling
Display the error messages given by the API.
---
### Wireframe
[Figma Wireframe](https://www.figma.com/file/nas0hU6wALYMd22JjSRzbz/Dev-Duel?node-id=0%3A1)
## As mentioned in the Assessment Overview at the top of this page, additional information and token setup for the server can be found in its respective folder `README.md`.
#### [server/README.md](server/README.md)