Skip to content

README.md

Latest commit

 

History

History
115 lines (100 loc) · 5.48 KB

README.md

File metadata and controls

115 lines (100 loc) · 5.48 KB

Netlify Status

Github Battle

GithubAPI Profile competition app

⚙ Features

  • React 17
  • React Router v5
  • React Hooks
  • ES8
  • PropTypes
  • Light/Dark Theme

👁️‍🗨️ Project Preview

Light Mode Dark Mode

🗺 URL Tree

├── /                          #Home
├── /battle                    #Battle
└── /*                         #404

🌿 Application Tree

├── README.md
├── package.json
├── public
│   ├── _redirects
│   ├── assets
│   │   ├── github-battle-1.png
│   │   ├── github-battle-2.png
│   │   ├── github-battle-3.png
│   │   ├── github-battle-4.png
│   │   ├── github-battle-5.png
│   │   ├── github-battle-6.png
│   │   └── github-battle_logo.png
│   └── index.html
├── src
│   ├── components
│   │   ├── Card
│   │   │   ├── card.css
│   │   │   └── index.js
│   │   ├── Loading
│   │   │   └── index.js
│   │   ├── Nav
│   │   │   ├── index.js
│   │   │   └── nav.css
│   │   └── Tooltip
│   │       └── index.js
│   ├── contexts
│   │   └── theme.js
│   ├── hooks
│   │   └── useHover.js
│   ├── index.css
│   ├── index.js
│   ├── pages
│   │   ├── Battle
│   │   │   ├── battle.css
│   │   │   ├── components
│   │   │   │   ├── Instructions
│   │   │   │   │   ├── index.js
│   │   │   │   │   └── instructions.css
│   │   │   │   ├── PlayerInput
│   │   │   │   │   ├── index.js
│   │   │   │   │   └── player-input.css
│   │   │   │   └── PlayerPreview
│   │   │   │       ├── index.js
│   │   │   │       └── player-preview.css
│   │   │   └── index.js
│   │   ├── Popular
│   │   │   ├── components
│   │   │   │   ├── LanguagesNav
│   │   │   │   │   ├── index.js
│   │   │   │   │   └── languages-nav.css
│   │   │   │   └── ReposGrid
│   │   │   │       ├── index.js
│   │   │   │       └── repos-grid.css
│   │   │   ├── index.js
│   │   │   └── popular.css
│   │   └── Results
│   │       ├── components
│   │       │   └── ProfileList
│   │       │       ├── index.js
│   │       │       └── profile-list.css
│   │       ├── index.js
│   │       └── results.css
│   └── utils
│       └── api.js
└── webpack.config.js

⛰️ Roadmap

  • Mobile version

📝 Todos

  • Re-factor large components.
  • Re-structure folders.
  • Re-write in Typescript.
  • Refactor in styled components.
  • Handle input undefined username.
  • Add Better preview images (larger, animated).
  • Rename public assets for context.
  • Add Favicon.