https://github.com/eugustavo/github-badges
Application made to create badges for your readme 📑
https://github.com/eugustavo/github-badges
badges create-badges generate-badges github-badges reactjs typescript
Last synced: about 1 month ago
JSON representation
Application made to create badges for your readme 📑
- Host: GitHub
- URL: https://github.com/eugustavo/github-badges
- Owner: eugustavo
- License: mit
- Created: 2020-07-07T16:43:22.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T22:47:15.000Z (over 1 year ago)
- Last Synced: 2024-07-31T19:54:31.702Z (9 months ago)
- Topics: badges, create-badges, generate-badges, github-badges, reactjs, typescript
- Language: TypeScript
- Homepage: https://github-badges.netlify.app/
- Size: 833 KB
- Stars: 164
- Watchers: 3
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README-EN.md
- License: LICENSE
Awesome Lists containing this project
- project-awesome - eugustavo/github-badges - Application made to create badges for your readme 📑 (TypeScript)
- awesome-github-profile - Github Badges
README
Github badges is an web application, built with ReactJS, to facilitate bagdge creation for projects README's. Acess
here
---
## 🚀 Installation and execution
To clone and execute the application, you have to install: [Git](https://git-scm.com), [Node.js](https://nodejs.org) + [Yarn](https://yarnpkg.com). With theese programs installed, execute the following command lines:
```bash
# Clone this repository
$ git clone https://github.com/eugustavo/github-badges
# Acess this repository
$ cd github-badges
# Install the dependencies
$ yarn install
# Start the application
$ yarn start
```
## 🤔 How to contribute
If you want to contribute for this project, either correcting an error, adding comments or working to make the code/documentation better, you can follow the tutorial below:
- Do [a fork](https://help.github.com/pt/github/getting-started-with-github/fork-a-repo) of this repository;
- Go to your profile, and clone your repository that you have *forked*;
- Make a *branch* with your changes: `git checkout -b my-change`;
- Do the necessary alterations in the code or in the documentation;
- Do a *commit* of your changes: `git commit -m 'feat: my new feature'`;
- Do a *push* to your *branch*: `git push origin my-change`;
- Now it's just open a *pull request* in the *forked* repository;
After the *merge* of your *pull request* have been done, you can delete your *branch*.
---
Maded with ♥ by Gustavo Souza :wave: [Contact](https://www.linkedin.com/in/eugustavosouza/)