Skip to content

Latest commit

 

History

History
100 lines (64 loc) · 4.42 KB

README.md

File metadata and controls

100 lines (64 loc) · 4.42 KB
Raw

GitHub for me (github4m)

Side note

The question is always "Why GitHub?". I am yet to see a project built primarily with black and white and looks this awesome. It is robust too.

Overview

This is a clone of Github. I have earlier done this before but here is a combine effort of all my previous try of which some were done over 2 years ago. For your reference, kindly check out:

  • Githook - Primarily has user search functionality with some query filter functions.
  • Githubb - Optimize the full potentials of GitHub GraphQL API
  • Github - A clone of Github home page

I must confess, GitHub has really improved and a lot has changed. This inspired me to try it all afresh.

Getting started

This is a clone of GitHub that primarily features user and repository search.

  • Use the search input to search for a keyword
  • The keyword returns a list of users who has the keyword in their details
  • Select a user from the result to view their repositories
  • Both the user and repository card has some hyperlinks which may lead you out of the app.
  • This implemetation features dark mode based on system theme.
  • It also has HTTP caching to avoid resources refetching.

Framework & Libraries

  • Vue 3 - Rendering of the UI and Reactivity system
  • Pinia - Vue 3 official store
  • Vite - A super fast server
  • Vue Apollo - Add GraphQL in your Vue.js apps with Apollo.js
  • Typescript - Strongly typed programming language to add types syntax to your JavaScript
  • Day.js - A fast 2kB javascript date utility library

Performance & Optimization

In no way have I tested the performance. I only optimize if needed.

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

  1. Disable the built-in TypeScript Extension
    1. Run Extensions: Show Built-in Extensions from VSCode's command palette
    2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
  2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Customize configuration

See Vite Configuration Reference.

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Lint with ESLint

npm run lint

Authors

See also the list of contributors who participated in this project.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. 🙇

Kindly contact me on 📧 [email protected]. You can review my resume here. 🤓. Thank you