Skip to content

artemkdr/github-contributions-custom-message

Repository files navigation

Create your custom message in GitHub contributions style

This is a simple html page that generates a message in a style of GitHub contributions grid. You can use it to create an image for your social profiles or your CV, etc.

Welcome example

How to run on your local machine

  1. Clone the repository
    git clone https://github.com/artemkdr/github-contributions-custom-message
    cd github-contributions-custom-message
  2. Run npm install to install dependencies
  3. Run npm run dev to start dev the server
  4. Open http://localhost:3000 in your browser

Other available commands

  • npm run build - build the project
  • npm run preview - preview the build
  • npm run typecheck - run typescript type check
  • npm run lint - run eslint
  • npm run lint:fix - run eslint with --fix option
  • npm run format - run prettier
  • npm run test - run tests
  • npm run test:watch - run tests in watch mode

Credits

I used html-to-image library to generate the images from html page.

The project is hosted on Vercel.

About

This is a fun project - a page with javascript for generating a message in a style of GitHub contributions graph.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors