https://github.com/tejashah88/devpost-shields
Devpost-themed shield badges to showcase your project.
https://github.com/tejashah88/devpost-shields
badge devpost hackathon vue
Last synced: about 1 month ago
JSON representation
Devpost-themed shield badges to showcase your project.
- Host: GitHub
- URL: https://github.com/tejashah88/devpost-shields
- Owner: tejashah88
- License: mit
- Created: 2018-12-11T08:59:39.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T08:49:34.000Z (7 months ago)
- Last Synced: 2025-03-27T19:22:59.736Z (about 2 months ago)
- Topics: badge, devpost, hackathon, vue
- Language: Vue
- Homepage: https://devpost-shields.com/
- Size: 1.47 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# devpost-shields
Devpost-themed shield badges to showcase your project. Powered by the same tech that [shields.io](https://shields.io) uses!
## Why?
The majority of hackathons I've attended over the years use Devpost as their method of submitting projects. Additionally, a good chunk of my GitHub-hosted projects were made from hackathons at the time, and I wanted to show showcase that fact. Sure, I could have just pasted a link to the Devpost submission but that's boooooriiiiiiing. :stuck_out_tongue:
## How to use
1. Go to the website [here](https://devpost-shields.com/).
2. Find any Devpost project that you've posted. A table of badges will be generated as shown above.
3. The types of badges are stated by the row labels and the styles are stated by the column labels. You can click on the buttons above to hide certain rows and columns.
4. Click on the clipboard icon for any of the badges. The resulting markdown will be copied to your clipboard.
5. Paste it on any markdown file (like your README), and the badge will instantly load whenever the markdown file is rendered.
## Caveats
This website is NOT responsive-ready and works best with desktop-like screens. I recommend using this website on a desktop/laptop and zooming out if needed.
## Don't want to use the web interface?
We got you covered! You can use the following format to create your own badges with ease.
#### How to create the badge image:
```
https://badges.devpost-shields.com/get-badge?name=project-name&id=project-id&type=badge-type&style=badge-style
```
* *project-name* = the name of the project that will be displayed on the badge
* *project-id* = the id of the project (from https://devpost.com/software/project-id)
* *badge-type* = one of the six badge types that you can choose from as shown below
* `basic` - Basic (Doesn't work with `popout` and `popout-square`)
* `custom-color` - Custom Color (Doesn't work with `popout` and `popout-square`)
* `small-logo-left-text-none` - Logo & No Text
* `small-logo-left-text-blend` - Logo & Blended Text
* `small-logo-left-text-full` - Logo & Full Text
* `big-logo` - Big Logo
* *badge-style* = one of the six badge styles that you can choose from as shown below
* `plastic` - Plastic
* `flat` - Flat
* `flat-square` - Flat (Square)
* `for-the-badge` - "For The Badge"
* `popout` - Popout (Doesn't work with `basic` and `custom-color`)
* `popout-square` - Popout (Square) (Doesn't work with `basic` and `custom-color`)
#### How to embed the badge in markdown:
```
[](devpost-link)
```
* *devpost-project-name* - the name of the project on Devpost (or really anything that you want)
* *badge-image-url* - the badge image URL that you created above
* *devpost-link* - the link to the devpost project (or really anything that you want)
## Powered by...
* *Vue.js*, for the frontend logic
* *Node.js*, for the backend logic
* *gh-badges*, the same npm module from the authors that created shields.io
* *AWS Lambda*, for serving badges to your markdown pages
* *GitHub Pages*, for hosting the website itself
* *Route 53*, for the custom domain