/githubb

A clone of the Github repository page and an improvement to https://github.com/MubarakSULAYMAN/github, optimizing the full potentials of GitHub GraphQL API.

Primary LanguageVue

Githubb

A clone of github repository page.

Githubb is built with vue, vuetify and lots love ❤️ 💖, and deployed on netlify.

Because of our believe in being progressive, we believe ths is just a work in progress 🚧. But, feel free to explore 🪐 Githubb, thank you friend.

Table of contents

(Back to top)

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

(Back to top)

Prerequisites

The things you will need in order to use the app and how to install them

  • Before you begin, ensure you have the latest node installed on your computer - Node.js 14.16.1 was used for this

Check with:

# ensure Node.js is >= 14.16.1
vue --version
  • Also ensure you have the latest vue cli installed - Vue CLI 3.O was used for this

Check with:

# ensure Vue CLI is >= 3.0
vue --version

(Back to top)

Project setup

This will walk you through how to setup the app on your local computer and/or machine.

Install all packages, plugins and dependencies

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Run your unit tests

npm run test:unit

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.

How to use / About the App

Enter a valid github username in the input box to get aview of their repositories. You can also access the repository page by modifying the URL accordingly too.

(Back to top)

Built with

  • Vue 2 - The progressive javasript framework used
  • External libraries used in this project includes:
    • Day.js - A fast 2kB javascript date utility library
    • Vue Router - The official router for Vue.js
    • Vuex - A state management pattern + library for Vue.js applications
    • vue-meta - A HTML Metadata manager for Vue.js
    • Airbnb JavaScript Style Guide - A HTML Metadata manager for Vue.js
    • Jest - A JavaScript testing framework

(Back to top)

Authors

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

(Back to top)

Contributing

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

Please make sure to update tests as appropriate.

(Back to top)

Acknowledgments

(Back to top)