Skip to content
/ github_contributions Public template

This project was motivated by a funny LinkedIn post by JavaScript Developer

Notifications You must be signed in to change notification settings

v-limo/github_contributions

Repository files navigation

Github Contributions calendar clone

1. What is this?

This project was motivated by this LinkedIn post by JavaScript Developer

  • The app uses React and Tailwind CSS to display the list of contributions made by the user on GitHub and the number of contributions made on each day of the week.
  • Its a partial clone of the GitHub Contributions Calendar

2. Demos

2.2 Screenshot of inspiration post

single user Page

2.3 Screenshot of the app

single user Page

NOTE : Does not work for private repositories

3. To come

  • Make the contributions dynamic to the user's GitHub profile
  • Including years in the calendar and making it dynamic
  • improve the UI - add a toggle button to switch between light and dark mode
  • Add a feature to show the number of contributions made on each day of the week
  • Move all the state to redux

4. Available Scripts

In the project directory, you can run:

npm start

npm test

  • Launches the test runner in the interactive watch mode.
    See the section about running tests for more information.

npm run build

  • Builds the app for production to the build folder.
    It correctly bundles React in production mode and optimizes the build for the best performance.

  • The build is minified and the filenames include the hashes.
    Your app is ready to be deployed!

  • See the section about deployment for more information.

5. Learn More

  1. You can learn more in the Create React App documentation.

  2. To learn React, check out the React documentation.

  3. Learn Tailwind CSS here

  4. Learn GitHub API here

  5. Github Contributions Calendar here

6. Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

About

This project was motivated by a funny LinkedIn post by JavaScript Developer

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published