Skip to content
Open
Show file tree
Hide file tree
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
49 changes: 23 additions & 26 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,42 @@

# 🤝 Introducing `PromiViz`
<p align="center">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.</p>
<p align="center">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.
</p>
<p align="center">
<a href="https://promiviz.vercel.app/" target="blank">View Demo</a>
<a href="https://promiviz.vercel.app/" target="blank">View Demo
</a>
·
<a href="https://blog.greenroots.info/series/javascript-promises" target="blank"> Learn </a>
.
<a href="https://github.com/atapas/promiviz/issues/new/choose" target="blank">Report Bug</a>
<a href="https://blog.greenroots.info/series/javascript-promises" target="blank"> Learn
</a>
<a href="https://github.com/atapas/promiviz/issues/new/choose" target="blank">Report Bug
</a>
·
<a href="https://github.com/atapas/promiviz/issues/new/choose" target="blank">Request Feature</a>
</p>

<a href="https://github.com/atapas/promiviz/issues/new/choose" target="blank">Request Feature
</a>
</p>
<p align="center">
<img src="social/landing2.png">
<img src="social/landing2.png">
</p>

`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 <b>PromiViz</b> to grow 💪 stronger.

## Many Thanks to all the `Stargazers` who have supported this project with stars(⭐)

## 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`.
Expand All @@ -47,13 +47,14 @@ Please access PromiViz using the URL:
- 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.
Expand All @@ -63,25 +64,28 @@ Here are some of the future enhancements planned:
- 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) JavaScript

True, 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

# 🏃‍♀️ Deploy
<a href="https://vercel.com/new/project?template=https://github.com/atapas/promiviz">
<img src="https://vercel.com/button" height="37.5px" />
</a>
Expand All @@ -92,23 +96,16 @@ This project is licensed under the MIT License - see the [`LICENSE`](LICENSE) fi

# 🤝 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

# 🙏 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 href="https://www.buymeacoffee.com/greenroots">
<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" height="50px">
</a>

---

<h3 align="center">
A ⭐️ to <b>PromiViz</b> is to build it 💪 stronger.
</h3>
Binary file added images/LinkedIn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.