Github Wrapped

Generate attractive cards to share in public your Github's Year Status.

Follow these steps to set up the Project To-Do List Manager on your local machine:

1. Clone the repository to your local environment using Git:

git clone https://github.com/amitjimiwal/Github-Wrapped.git

2. Navigate to the project directory:

cd Github-Wrapped

3. Install the required dependencies:

npm install

4. Add your Github Personal Access Token in a .env file

GITHUB_ACCESS_TOKEN=Your Access Token

5 . Build the project:

npm run build

6. Start the application:

npm run dev

The application will now be running on your local machine at http://localhost:3000.

We welcome contributions to enhance the functionality and usability of the Project Github Wrapped. If you'd like to contribute, follow these steps:

1. Fork the repository from the GitHub page: https://github.com/amitjimiwal/Github-Wrapped

2. Clone your forked repository to your local machine.

3. Create a new branch for your feature or bug fix:

git checkout -b feature/your-feature-name

4. Make your changes and commit them with descriptive commit messages:

git commit -m "Add new feature" -m "Description of the changes."

5. Push the changes to your forked repository:

git push origin feature/your-feature-name

6. Create a pull request on the original repository, explaining the changes you made and their benefits.

We appreciate your contributions, and together, we can make the Github Wrapped even better!

The Github Wrapped is licensed under the MIT License. Feel free to use, modify, and distribute the software as per the terms of the license.

Thank you for taking an interest Github Wrapped ! If you encounter any issues, have suggestions, or want to report a bug, feel free to create an issue on the GitHub repository. Happy Coding!