Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/atapas/webapis-playground

The Web APIs Playground is a project to showcase the JavaScript Web APIs with examples and demonstrations. Client-side JavaScript APIs are here to help with providing wrapper functions for many low-level tasks.
https://github.com/atapas/webapis-playground

hacktoberfest javascript js nextjs web-api

Last synced: 10 days ago
JSON representation

Host: GitHub
URL: https://github.com/atapas/webapis-playground
Owner: atapas
License: mit
Created: 2021-06-16T10:08:21.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-08-07T08:34:20.000Z (3 months ago)
Last Synced: 2024-10-15T10:52:37.450Z (24 days ago)
Topics: hacktoberfest, javascript, js, nextjs, web-api
Language: TypeScript
Homepage: https://webapis-playground.vercel.app/
Size: 2.43 MB
Stars: 299
Watchers: 3
Forks: 72
Open Issues: 40
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

my-awesome-list - webapis-playground - side JavaScript APIs are here to help with providing wrapper functions for many low-level tasks. | atapas | 300 | (TypeScript)

README

# 🔌 WEB APIS PLAYGROUND

[![All Contributors](https://img.shields.io/badge/all_contributors-27-orange.svg?style=flat-square)](#contributors-)

The `Web APIs Playground` is a project to showcase the JavaScript Web APIs with examples and demonstrations. Client-side JavaScript APIs provides wrapper functions for many low-level tasks like,

- Device Hardware Interactions
- Client-side storage interactions
- 3D Graphics, WebGL
- Notifications
- Audio, Video
- and many, many more.

Please [follow this link](https://developer.mozilla.org/en-US/docs/Web/API) to know about different Web APIs and their usages.

# 🔥 The App

> [https://webapis-playground.vercel.app](https://webapis-playground.vercel.app)

# 🎯 Vision and Mission of this Playground

The primary mission is to provide working examples of the JavaScript web APIs with simple demonstration that can be accessed using browsers on different devices. It may help many beginners to this topic in understanding how to code and use the Web APIs.

# 🏗️ How to ADD a new DEMO?

[Here is a step-by-step guide](./HOW-TO-ADD-DEMO.md) to help you add a new demo.

# ⚒️ It's developed using Next.js

This project is developed using `Next.js`. If you have implemented a similar project using JavaScript or any other frameworks like `React`, `Angular`, `Vue`, please create an issue to include them in the README.

# 🤲 Want to Motivate?

Who doesn't need motivation? Please give the project a star(⭐) and/or share it in your dev circle.

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

[![Stargazers repo roster for @atapas/webapis-playground](https://reporoster.com/stars/atapas/webapis-playground)](https://github.com/atapas/webapis-playground/stargazers)

# 🏃‍♀️ How to Run the project locally

To run the project locally,

- Please clone it.
- Browse to the project directory.
- Install dependencies
- Use Node **16.x.x** or [Node Version Switcher](https://github.com/jasongin/nvs)

```bash
npm install
# Or
yarn install
```

- Run the application locally

```bash
npm run dev
# Or
yarn dev
```

- Open the browser and navigate to `http://localhost:3000`

# 🚀 What's Included?

So far, it includes the following examples:

1. 📂 File System API
1. 📺 FullScreen API
1. 📋 Clipboard API
1. 📡 Broadcast
1. 📷 Image Capture
1. 📶 Network Info
1. 🧐 Resize Observer
1. 💳 Payment Request
1. 📳 Vibration API
1. 🔋 Battery API
1. 🐢 Drag and Drop
1. ⚓ Geolocation API
1. 🖼️ Picture in Picture
1. 💻 Screen Capture
1. ✍️ CSS Font Loading
1. 🎙️ Web Speech API
1. 🎨 Canvas API
1. 👆 Pointer Capture API
1. 🌐 URL API
1. 🗒️ Selection API
1. 📃 Page Visibility API
1. 💬 WebRTC

# 🤝 Open Source

This project is open source and open for contributions. If you are looking for any examples and demonstrations that are missing, please [open an issue from here](https://github.com/atapas/webapis-playground/issues). You can also contribute to the source code by adding an example, improving the code and providing suggestions.

# 🤝 Contributing to `playground`

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 issues [listed here](https://github.com/atapas/webapis-playground/issues) or create one on your own. After adding your code, please send us 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. `WebAPIs Playground` is not an exception. Please give this project a ⭐️ to encourage and show that you liked it.

If you found the app helpful, consider supporting us with a coffee.