Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atapas/promiviz
Visualize JavaScript Promises on the browser. Visualize the JavaScript Promise APIs and learn. It is a playground to learn about promises faster, ever!
https://github.com/atapas/promiviz
hacktoberfest interview javascript promise promise-api promises
Last synced: 6 days ago
JSON representation
Visualize JavaScript Promises on the browser. Visualize the JavaScript Promise APIs and learn. It is a playground to learn about promises faster, ever!
- Host: GitHub
- URL: https://github.com/atapas/promiviz
- Owner: atapas
- License: mit
- Created: 2021-08-18T09:47:06.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-27T19:46:20.000Z (5 months ago)
- Last Synced: 2024-10-31T14:45:16.128Z (13 days ago)
- Topics: hacktoberfest, interview, javascript, promise, promise-api, promises
- Language: JavaScript
- Homepage: https://promiviz.vercel.app
- Size: 2.64 MB
- Stars: 98
- Watchers: 2
- Forks: 43
- Open Issues: 25
-
Metadata Files:
- Readme: Readme.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ๐ค Introducing `PromiViz`
Visualize the JavaScript Promise APIs and learn. It is a playground to learn about promises faster than ever! A tool built for developers by a developer.
View Demo
ยท
Learn
.
Report Bug
ยท
Request Feature
`PromiViz` is an open-source tool to visualize the JavaScript Promise APIs. It is a playground for developers to configure promises with delays, resolve/reject, and more.
# ๐ Demo
Here is a quick demo of the app. I hope you enjoy it.> [The Demo Link](https://www.youtube.com/watch?v=webs_tRKIIg)
Liked it? Please give a โญ๏ธ to PromiViz to grow ๐ช stronger.
## Many Thanks to all the `Stargazers` who have supported this project with stars(โญ)
[![Thanks to all stargazers](https://git-lister.onrender.com/api/stars/atapas/promiviz?limit=15)](https://github.com/atapas/promiviz/stargazers)
# ๐ป Use PromiViz
Please access PromiViz using the URL:> https://promiviz.vercel.app/
# ๐ฅ Features
`PromiViz` comes with a bundle of features already. You can do the following with it:- Schedule a promise to resolve/reject after a delay.
- Reject a promise specifically.
- Run and test all the Promise APIs, `all`, `any`, `allSettled`, `race`, `resolve`, `reject`.
- Show logs of the execution of the promises. The log includes time, text, and emojis to indicate the status of the promise.
- Ability to retain the logs for a session.
- Ability to clear the logs.
- Ability to set themes.
- Responsive and mobile-friendly.
- It is a PWA(Progressive Web App).# How is it helpful to you?
JavaScript promises are a bit of a complex topic to understand for beginners. However your interviewers will love to ask questions about this topic. Hence an in-depth understanding
of how it works internally would be a great advantage.`PromiViz` will help you with that. You can run the promises, customize them, and see the execution
logs to understand what's happening. You can also modify the settings, try different combinations of the APIs, resolve/reject to firm up your understanding.# ๐ฆ What are the future enhancements?
Here are some of the future enhancements planned:
- Schedule a promise to resolve/reject after a delay with a custom message.
- Ability to add more promises (beyond the three out-of-the-boxes).
- Ability to run customized examples from the app.
- Ability to run the promises in a loop to showcase the loop-related use-cases.
- Persist a history of promise runs.
- Persist logs across sessions.
- More themes.
# ๐ Built With
I built this app with the following technologies:
- HTML
- CSS
- (Plain New) JavaScriptTrue, No React, Angular, Vue, yet. As it was done as an initial prototype, I may move the app to a framework later.
# ๐๏ธ How to Set up `PromiViz` for Development?
- Clone the repository.
- Browse to the project directory.
- Just run the `index.html` file with any server of your choice. You can use `npx serve`, or if you
are using `VS Code`, you can use the `Live Server` extension to run it.# ๐ก๏ธ License
This project is licensed under the MIT License - see the [`LICENSE`](LICENSE) file for details.# ๐โโ๏ธ Deploy
# ๐ค Contributing to `PromiViz`
Any kind of positive contribution is welcome! Please help us to grow by contributing to the project.If you wish to contribute, you can work on any features or create one on your own. After adding your code, please send a Pull Request.
> Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md) and the process for submitting pull requests to us.
# ๐ Support
We all need support and motivation. `PromiViz` is not an exception. Please give this project a โญ๏ธ to encourage and show that you liked it. Don't forget to leave a star โญ๏ธ before you move away.
If you found the app helpful, consider supporting us with a coffee.
---
A โญ๏ธ to PromiViz is to build it ๐ช stronger.