Overview:
GitHub Wrapped is a web application that provides a personalized summary of a user’s GitHub activity. Users can view their GitHub data in a visually engaging format and gain insights into their coding habits and contributions.
Features:
- Personalized Summary: View a comprehensive overview of GitHub activity
- Integration with Supabase: Utilize Supabase for account management and database functionalities
- Real-time Updates: Changes to components reflect in the browser instantly
- Open Source Contribution: Users can contribute to the project through issue tracking and pull requests
Installation:
- Ensure you have yarn installed on your system.
- Clone or fork the repository to your local machine.
- Create a
.envfile with necessary environment variables. Refer to.sample-envfor guidance. - Set up a Supabase account and create a new database. Add the database key to your
.envfile. - Run
yarn installin the terminal to install project dependencies. - Execute
yarn devin the terminal to run the application locally atlocalhost:3000/. - Access the application in your browser using the provided local address.
Summary:
GitHub Wrapped is a user-friendly web application that presents a personalized summary of a user’s GitHub activity. By leveraging Supabase for account management and database operations, users can seamlessly interact with their GitHub data in real-time while enjoying the benefits of open-source contributions. The setup process is straightforward, making it easy for users to install and start exploring their GitHub insights.