hamsternik / yourfirstcommit

Mobile and web app to discover the first commit of any GitHub public repository 🤔

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

🥇 Your First Commit

The web app displays GitHub repo history starting from the very first commit. (yeah, in ascending order)

The Blueprint

The project divided by several steps:

  • Proof of concept (PoC)
  • Product requirements document (PRD)
  • Minimal viable product (MVP) v1.0.0

Proof of Concept

First, the concept. We are driving to build the first feasible produdct following the next rules:

Keep your proof of concept as simple and bare bones as possible. To help keep costs down and reduce the time required to build it, you should:

  • Keep the PoC development team small. Minimizing the number of people working on the PoC will help to keep the work more efficient.
  • Minimize the amount of UI/UX design work. This type of work can be costly. Only do work that is strictly necessary to meet the goals you established for your PoC.
  • Focus only on the goals you established for your PoC. Do not attempt to build an MVP. That should be a separate stage of development.
  • After you have your proof of concept built, you’ll be ready to start assessing the results!

The concept goal is only to show the project's very first commit. We are going to use original GitHub web site. Implementation of the commit's code changes is out of scope for the PoC. Please wait until the PRD would be fulfilled and the set of requirements would be finalized.

Goals

  • Main page with the search bar in the middle of the web page. As example look at the npm.io or npms.io.
  • User is able to enter a GitHub repo URL in the search bar.
  • Display the list of first N projects aligned with the user input.
  • Open the GitHub repository's web page with the first commit of the selected project.
  • Support only open-source projects. PoC will not support GitHub user authentication to open any private repos visible for concrete user account.

Tech Specification

Web

Next.js, TypeScript. Single page application with the redirection to the GitHub web site by the project URL.

iOS

Swift 5+, SwiftUI, Async / Await, Combine. iOS only app. The application launch state contains only the navigation bar & search bar in the top. When the user enters any char in the search bar the client is going to request data from the GitHub. Then display the result as the list of N first repos that are provided in the response. Clicking on the repo will open the Safari in-app browser with the first commit of the selected repository.

Design & Implementation

About

Mobile and web app to discover the first commit of any GitHub public repository 🤔

License:MIT License


Languages

Language:Swift 75.9%Language:CSS 15.8%Language:TypeScript 8.0%Language:JavaScript 0.3%