cornerstone-04 / github-portfolio

AltSchool Frontend Second Semester Examination Project

Introduction

My GitHub Portfolio App

Welcome to My GitHub Portfolio App! This application showcases my GitHub repositories in a sleek web interface. Whether you're a recruiter or a fellow developer, you can easily navigate through my projects, view detailed information, and even check out the source code.

Features

1. Repository List: View a list of all my public repositories on GitHub. Click on a repository to see detailed information about that project.
2. Repository Details: Get more detailed information on any repository. This includes the description, number of stars, programming language used, and other relevant data.
3. Error Handling: The app gracefully handles errors, ensuring a smooth user experience. If something goes wrong, you'll be guided on how to refresh or navigate back to the main page.
4. Responsive Design: Enjoy a seamless experience on both desktop and mobile devices, thanks to the responsive design.
5. 404 Page: If you try to navigate to a non-existent page, you'll be directed to a custom 404 page with guidance to get back on track.

How It Works

This web app uses the GitHub API to fetch data about my repositories. It's built with React, showcasing modern practices like nested routing, error boundaries, and functional components. The app's state-of-the-art error boundary technology ensures that any hiccups are handled gracefully, improving reliability and user experience.

Built With

🖼️ Screenshot

(back to top)

📚 Getting Started

To get a local copy, follow these simple steps.

Prerequisites

Before installation, please make sure you have already installed the following tools:

• Git
• NodeJs

Installation

1. Fork the project. Click on the fork icon in the top right to get started

2. Clone the project, you can use the following command:

   git clone https://github.com/<your-github-username>/github-portfolio.git

3. Navigate to the project directory

   cd github-portfolio

4. Install dependencies with yarn

   yarn

5. Start application

   yarn dev

(back to top)

🎨 Demo

Check out the website: Github Portfolio

(back to top)

👩🏽‍💻 Contributing

(back to top)