Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 48 additions & 63 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,48 @@
# Dynamic Progress Bar
# πŸš€ Dynamic Progress Bar

Generates a dynamic progress bar image (SVG) using Python, which is deployed freely via Vercel.
Generates a **dynamic progress bar image** (SVG) using **Python**, deployed freely via **Vercel**.

![Progress](https://progress-bar.xyz/25/) ![Progress](https://progress-bar.xyz/50/) ![Progress](https://progress-bar.xyz/100/)
πŸ“Š **Preview:**

![Progress](https://progress-bar.xyz/25/) ![Progress](https://progress-bar.xyz/50/) ![Progress](https://progress-bar.xyz/100/)

Inspired by [![fredericojordan/progress-bar](https://img.shields.io/badge/fredericojordan%2Fprogress--bar-black?style=flat&logo=github)](https://github.com/fredericojordan/progress-bar).

---

## Other projects
## πŸ”₯ Other Projects

- [![Star Rating](https://starrating-beta.vercel.app/5.0/)](https://github.com/GoulartNogueira/Star-Rating) Dynamic Star Rating - [![GoulartNogueira/Star-Rating](https://img.shields.io/badge/GoulartNogueira%2FStar--Rating-black?style=flat&logo=github)](https://github.com/GoulartNogueira/Star-Rating)
- ⭐ [![Star Rating](https://starrating-beta.vercel.app/5.0/)](https://github.com/GoulartNogueira/Star-Rating) **Dynamic Star Rating** - [![GoulartNogueira/Star-Rating](https://img.shields.io/badge/GoulartNogueira%2FStar--Rating-black?style=flat&logo=github)](https://github.com/GoulartNogueira/Star-Rating)

---

## Usage
## πŸ› οΈ Usage

This service is deployed on [Vercel](https://vercel.com) and accessible via the domain [progress-bar.xyz](https://progress-bar.xyz).
This service is deployed on **[Vercel](https://vercel.com)** and accessible via the domain **[progress-bar.xyz](https://progress-bar.xyz)**.

---

## Parameters

| Parameter | Description | Default Value |
|--------------------------|----------------------------------------------------------------------------------------|-----------------------|
| `title` | Adds a title to the progress bar | None |
| `scale` | The maximum value that the progress bar represents | 100 |
| `prefix` | A string to add before the progress number | None |
| `suffix` | A string to add after the progress number | % |
| `width` | The width of the progress bar in pixels | 100 |
| `color` | The color of the progress bar (hex code without `#`) | `00ff00` (green) |
| `progress_background` | The background color of the progress bar (hex code without `#`) | `ffffff` (white) |
| `progress_number_color` | The color of the progress number (hex code without `#`) | `000000` (black) |
| `progress_color` | The color of the progress bar (hex code without `#`) | Depends on percentage |
| `show_text` | If should display or hide the progress text | `true` |
| `style` | The style. One of: `default`, `flat`, `square`, `plastic`, `for-the-badge` | `default` |
## βš™οΈ Parameters

| πŸ”§ Parameter | πŸ“œ Description | 🎯 Default Value |
|-------------|---------------|------------------|
| `title` | Adds a title to the progress bar | None |
| `scale` | The maximum value that the progress bar represents | 100 |
| `prefix` | A string to add before the progress number | None |
| `suffix` | A string to add after the progress number | `%` |
| `width` | The width of the progress bar in pixels | 100 |
| `color` | The color of the progress bar (hex code without `#`) | `00ff00` (green) |
| `progress_background` | The background color of the progress bar (hex code without `#`) | `ffffff` (white) |
| `progress_number_color` | The color of the progress number (hex code without `#`) | `000000` (black) |
| `progress_color` | The color of the progress bar (hex code without `#`) | Depends on percentage |
| `show_text` | If should display or hide the progress text | `true` |
| `style` | The style. One of: `default`, `flat`, `square`, `plastic`, `for-the-badge` | `default` |

---

## Examples
### Examples

Below are several examples showcasing different ways to generate progress bars.

| Example Preview | URL |
| πŸ“Œ Preview | 🌐 URL |
|---------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|
| ![Progress](https://progress-bar.xyz/28/) | [https://progress-bar.xyz/28/](https://progress-bar.xyz/28/) |
| ![Progress](https://progress-bar.xyz/28/?title=progress) | [https://progress-bar.xyz/28/?title=progress](https://progress-bar.xyz/28/?title=progress) |
Expand All @@ -63,39 +62,36 @@

---

## Styles
## 🎨 Styles

We currently have `flat` (default), `square`, `plastic`, `for-the-badge`, `thin-rounded`, `neo-glass`, and `minimal-matte` styles:
We currently support:

| Example Preview | URL |
|----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| ![Progress](https://progress-bar.xyz/100/?style=flat) | [https://progress-bar.xyz/100/?style=flat](https://progress-bar.xyz/100/?style=flat) |
| ![Progress](https://progress-bar.xyz/100/?style=square) | [https://progress-bar.xyz/100/?style=square](https://progress-bar.xyz/100/?style=square) |
| ![Progress](https://progress-bar.xyz/100/?style=plastic) | [https://progress-bar.xyz/100/?style=plastic](https://progress-bar.xyz/100/?style=plastic) |
| ![Progress](https://progress-bar.xyz/100/?style=for-the-badge) | [https://progress-bar.xyz/100/?style=for-the-badge](https://progress-bar.xyz/100/?style=for-the-badge) |
| ![Progress](https://progress-bar.xyz/100/?style=thin-rounded) | [https://progress-bar.xyz/100/?style=thin-rounded](https://progress-bar.xyz/100/?style=thin-rounded) |
| ![Progress](https://progress-bar.xyz/100/?style=neo-glass) | [https://progress-bar.xyz/100/?style=neo-glass](https://progress-bar.xyz/100/?style=neo-glass) |
| ![Progress](https://progress-bar.xyz/100/?style=minimal-matte) | [https://progress-bar.xyz/100/?style=minimal-matte](https://progress-bar.xyz/100/?style=minimal-matte) |
| 🎨 Style | πŸ“Œ Preview | 🌐 URL |
|----------|-----------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| 🟒 **flat** (default) | ![Progress](https://progress-bar.xyz/100/?style=flat) | [https://progress-bar.xyz/100/?style=flat](https://progress-bar.xyz/100/?style=flat) |
| πŸ”² **square** |![Progress](https://progress-bar.xyz/100/?style=square) | [https://progress-bar.xyz/100/?style=square](https://progress-bar.xyz/100/?style=square) |
| πŸ›‘οΈ **plastic** | ![Progress](https://progress-bar.xyz/100/?style=plastic) | [https://progress-bar.xyz/100/?style=plastic](https://progress-bar.xyz/100/?style=plastic) |
| πŸ”– **for-the-badge** | ![Progress](https://progress-bar.xyz/100/?style=for-the-badge) | [https://progress-bar.xyz/100/?style=for-the-badge](https://progress-bar.xyz/100/?style=for-the-badge) |
| 🎭 **thin-rounded** |![Progress](https://progress-bar.xyz/100/?style=thin-rounded) | [https://progress-bar.xyz/100/?style=thin-rounded](https://progress-bar.xyz/100/?style=thin-rounded) |
| πŸͺž **neo-glass** | ![Progress](https://progress-bar.xyz/100/?style=neo-glass) | [https://progress-bar.xyz/100/?style=neo-glass](https://progress-bar.xyz/100/?style=neo-glass) |
| 🎨 **minimal-matte** | ![Progress](https://progress-bar.xyz/100/?style=minimal-matte) | [https://progress-bar.xyz/100/?style=minimal-matte](https://progress-bar.xyz/100/?style=minimal-matte) |

- thin-rounded**: A sleek, rounded progress bar with a minimalist feel.
- **neo-glass**: A modern glass-like effect with transparency.
- **minimal-matte**: A clean, soft matte finish.

---

## Deployment
## πŸš€ Deployment

You can deploy this project to Vercel with a single click:
Deploy this project to **Vercel** with a single click:

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/guibranco/progressbar)

---

## Contributing
## 🀝 Contributing

Refer to [CONTRIBUTING.md](CONTRIBUTING.md) to learn how to contribute to this project!
Check out [CONTRIBUTING.md](CONTRIBUTING.md) to learn how to contribute!

### Contributors
### πŸ‘₯ Contributors

<!-- readme: collaborators,contributors,snyk-bot/- -start -->
<table>
Expand Down Expand Up @@ -126,22 +122,15 @@
<a href="https://github.com/EduardoBaptista01">
<img src="https://avatars.githubusercontent.com/u/65791384?v=4" width="100;" alt="EduardoBaptista01"/>
<br />
<sub><b>EduardoBaptista01</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/bhosley">
<img src="https://avatars.githubusercontent.com/u/22378319?v=4" width="100;" alt="bhosley"/>
<br />
<sub><b>bhosley</b></sub>
<sub><b>Eduardo Baptista</b></sub>

Check notice on line 125 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L125

Element: sub
</a>
</td>
</tr>
<tbody>
</table>
<!-- readme: collaborators,contributors,snyk-bot/- -end -->

### Bots
### πŸ€– Bots

<!-- readme: bots,snyk-bot -start -->
<table>
Expand All @@ -154,13 +143,6 @@
<sub><b>dependabot[bot]</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/penify-dev[bot]">
<img src="https://avatars.githubusercontent.com/in/399279?v=4" width="100;" alt="penify-dev[bot]"/>
<br />
<sub><b>penify-dev[bot]</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/snyk-bot">
<img src="https://avatars.githubusercontent.com/u/19733683?v=4" width="100;" alt="snyk-bot"/>
Expand All @@ -175,6 +157,9 @@

---

## License
## πŸ“œ License

This project is licensed under the **MIT License**.

πŸ“„ See [LICENSE](LICENSE) for details.

This project is open-source and available under the MIT License.