YAS-opensource / ProgRace

Elegant progress-bar badges for Markdown in SVG format

Home Page:https://prograce.herokuapp.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ProgRace

Progress-bar badges for Markdown in SVG format

CircleCI Maintainability Codacy Badge

Maintenance GitHub last commit (branch) PRs Welcome GPLv3 license

How to use

Default

ProgRace

![ProgRace](https://prograce.herokuapp.com/?progress=20)

ProgRace

![ProgRace](https://prograce.herokuapp.com/?progress=34)

ProgRace

![ProgRace](https://prograce.herokuapp.com/?progress=80)

Custom range

You don't need to calculate the progress by hand and copy paste it here, just pass the total range as total and it's done, simple as that.

ProgRace

![ProgRace](https://prograce.herokuapp.com/?progress=10&total=20)

ProgRace

![ProgRace](https://prograce.herokuapp.com/?progress=755&total=1000)

Custom Title

You can also give it a custom title.

ProgRace

![ProgRace](https://prograce.herokuapp.com/?progress=50&total=100&title=Custom)

Contributing guideline

Install the dependencies:

pip install -r requirements.txt

Run the code:

python3 app.py

Open the browser and go to localhost:3000

Happy hacking! Make sure to open a PR when you are done!

Users

We will be happy to show the world our splendid users! To be listed here, just add your link to the project below this line and open a PR!

License

MIT License

Copyright (c) 2019 Samnan Rahee, Sihan Tawsik

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Elegant progress-bar badges for Markdown in SVG format

https://prograce.herokuapp.com

License:MIT License


Languages

Language:Python 94.6%Language:Dockerfile 3.9%Language:Makefile 1.5%