README.md

GitHub Timeline

GitHub Timeline is a web application that visualizes a GitHub user's public repositories in a timeline format, displaying repository names, creation dates, and descriptions. It also provides a summary of the number of repositories created each year.

Features

• Enter a GitHub username to generate a timeline of public repositories.
• Click the 'Generate' button to fetch and display the timeline.
• View repository names, creation dates, and descriptions.
• Summary of the number of repositories by year.
• Warning message if the GitHub username is invalid.

Technologies Used

• Next.js
• React
• Axios

Deployment

The application is automatically deployed to GitHub Pages using GitHub Actions upon each push to the main branch.

Getting Started

Prerequisites

• Node.js installed on your machine.

Installation

1. Clone the repository:

   git clone https://github.com/your-username/github-timeline.git

2. Navigate to the project directory:

   cd github-timeline

3. Install dependencies:

   npm install

4. Run the development server:

   npm run dev

5. Open http://localhost:3000 in your browser to view the application.

Configuration for GitHub Pages

1. Set the basePath in next.config.js:

   Replace /your-repo-name with the name of your GitHub repository.

2. Update the homepage in package.json:

   Although not mandatory for Next.js, it's good practice to set the homepage field if you plan to use other deployment methods.

License

This project is licensed under the MIT License.

Acknowledgements

Powerd by o1-mini

prompt based on app-ideas:

https://github.com/florinpop17/app-ideas/blob/master/Projects/3-Advanced/GitHub-Timeline-App.md