Giter VIP home page Giter VIP logo

github-profile-readme's Introduction

GitHub Profile READMEs

Build & Deploy GitHub pull requests GitHub closed pull requests GitHub contributors

Happy Hacktoberfest! Hacktoberfest is back ๐Ÿ”ฅ Github Profile Cards is a list of GitHub Profle README templates of Hacktoberfest 2020 participants.

Link to webpage: https://github-profile-readmes.firebaseapp.com/

Contributing

If this is your first pull request, please read this article: How To Create a Pull Request on GitHub

Read more about GitHub Profile README: GitHub Official Profile README Docs

Step 1

Fork the repo by pressing the "Fork" button on the top right side of the repository and clone your forked repository.

Step 2

In your forked repository, edit users.js (src/dataSet/users.js) and add your name and github userName to the bottom of the file using this format with adding a comma after the end of the previous user's data. :

  {
    name : "Full Name",
    githubUserName : "github userName"
  }

Step 3

In your forked repository, go to githubCards folder (src/dataSet/githubCards) and add you Github Profile README template keeping the name of the file as your github userName with extension as .md.

Example : 
if GitHub userName is srinibasbiswal, then the fileName will be :

srinibasbiswal.md

Step 4

Commit your changes and submit a pull request! After your pull request gets accepted, you will be able to see your very own GitHub README card on the Github Profile READMEs!

  • Make sure you have updated code from the master branch before making the pull request.

Step 5

Please star the repo if you like this fun little Hacktoberfest project โค๏ธ

How to run / debug in your local

After cloning the repo, run the following commands.

npm install
npm start
  • Make sure you have Node installed in your local system.

License

MIT

github-profile-readme's People

Contributors

srinibasbiswal avatar ankitabasera avatar aniketsingh98571 avatar aniruddhparwal avatar tmw9 avatar ayushmaloo avatar dedesaepulloh avatar shubhamdsm avatar pankaj-kb avatar lucasguiss avatar aayushi-mittal avatar kumaranshu72 avatar kdimas12 avatar driftingshadows avatar gioboa avatar aryan-chawla123 avatar vyasriday avatar konradlinkowski avatar leonardomath avatar vishalpattnaik avatar vivek32ta avatar shin-iji avatar sonilaia avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.