https://github.com/amitjimiwal/githubstats-me
Get Yourself your Github's Stats 🎉. Do ⭐️ the repo 😇
https://github.com/amitjimiwal/githubstats-me
apollo-client github githubwrap graphql hacktoberfest nextjs open-source tailwindcss typescript
Last synced: about 2 months ago
JSON representation
Get Yourself your Github's Stats 🎉. Do ⭐️ the repo 😇
- Host: GitHub
- URL: https://github.com/amitjimiwal/githubstats-me
- Owner: amitjimiwal
- Created: 2023-12-05T07:46:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-03T12:03:09.000Z (about 1 year ago)
- Last Synced: 2025-01-31T08:34:19.411Z (3 months ago)
- Topics: apollo-client, github, githubwrap, graphql, hacktoberfest, nextjs, open-source, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://githubstats-me.vercel.app
- Size: 165 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**Github Wrapped**
## About
Generate attractive cards to share in public your Github's Year Status.
## Installation
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:
```bash
git clone https://github.com/amitjimiwal/Github-Wrapped.git
```
2. Navigate to the project directory:
```bash
cd Github-Wrapped
```
3. Install the required dependencies:
```bash
npm install
```
4. Add your Github Personal Access Token in a .env file
```bash
GITHUB_ACCESS_TOKEN=Your Access Token
```
5 . Build the project:
```bash
npm run build
```
6. Start the application:
```bash
npm run dev
```
The application will now be running on your local machine at http://localhost:3000.
## Contribution
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](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:
```bash
git checkout -b feature/your-feature-name
```
4. Make your changes and commit them with descriptive commit messages:
```bash
git commit -m "Add new feature" -m "Description of the changes."
```
5. Push the changes to your forked repository:
```bash
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!
## License
The Github Wrapped is licensed under the [MIT License](https://opensource.org/licenses/MIT). 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](https://github.com/amitjimiwal/Github-Wrapped). Happy Coding!