Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jotrorox/progressapi
A simple API providing progress bars in all different types and forms to use in other project or simply to embed
https://github.com/jotrorox/progressapi
api caching image image-api java maven progress
Last synced: 8 days ago
JSON representation
A simple API providing progress bars in all different types and forms to use in other project or simply to embed
- Host: GitHub
- URL: https://github.com/jotrorox/progressapi
- Owner: Jotrorox
- License: agpl-3.0
- Created: 2024-06-03T23:18:04.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-06-04T14:32:14.000Z (6 months ago)
- Last Synced: 2024-06-05T01:47:10.920Z (6 months ago)
- Topics: api, caching, image, image-api, java, maven, progress
- Language: Java
- Homepage: http://github.com/jotrorox/progressapi
- Size: 84 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Progress API
About |
Features |
Development Requirements |
Development Setup |
Getting Started |
Contributing |
License |
Author
## :dart: About ##
Progress API is a simple API, that aims to provide a simple way to get and/or embed Progress bars into anything.
The API generates images that resemble the given percentage count. In the future this Project will also aim to support multiple different types of progress bars.
Now for the last part: Why? It is simple I just needed this for another project that I'm working on and because I just felt like it, I made it it's own project.
## :sparkles: Features ##
:heavy_check_mark: Generating the base images\
:heavy_check_mark: Exposing an api\
:heavy_check_mark: Adding Docker Support\
:heavy_multiplication_x: Allowing different Progressbars
## :white_check_mark: Development Requirements ##
Before starting :checkered_flag:, you need to have [Git](https://git-scm.com) and [NodeJS](https://nodejs.org/en) installed.
## :checkered_flag: Starting (Development Setup) ##
```bash
# Clone this project
$ git clone https://github.com/Jotrorox/progressapi
# Go into that directory
$ cd progressapi
# Install all dependencies
$ npm i
# Run the Project
$ npm run start
# Run the Project in dev mode
$ npm run dev
```
**If you encounter Problems just hit me up, I'm happy to help you get started**\
**You can do that over matrix: @jotrorox:matrix.org or Discord: https://discord.gg/RVr4cceFUt**
## :dash: Getting Started ##
I will explain the Docker way here so please ensure you have Docker installed!
```bash
# Pull the project
$ docker pull jotrorox/progressapi
# Start the bot
$ docker run -e PORT= jotrorox/progressapi
```
## :raised_hands: Contributing ##
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## :memo: License ##
This project is under the AGPLv3 License. For more details, see the [LICENSE](LICENSE) file.
Made with :heart: by Jotrorox