Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/FormidableLabs/runpkg
the online javascript package explorer
https://github.com/FormidableLabs/runpkg
Last synced: 3 months ago
JSON representation
the online javascript package explorer
- Host: GitHub
- URL: https://github.com/FormidableLabs/runpkg
- Owner: FormidableLabs
- License: mit
- Created: 2019-04-18T13:43:29.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-09-05T12:17:20.000Z (about 1 year ago)
- Last Synced: 2024-05-11T14:32:57.192Z (6 months ago)
- Language: JavaScript
- Homepage: https://runpkg.com/
- Size: 1.77 MB
- Stars: 307
- Watchers: 45
- Forks: 11
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - runpkg
- awesome-tools - **runpkg** - 在线 npm 包浏览器 https://runpkg.com/ (在線使用)
README
[](https://formidable.com/open-source/)
[![Maintenance Status][maintenance-image]](#maintenance-status)
> the online package explorer
Runpkg turns a static file into an interactive and informative browsing experience. It lets you navigate any JavaScript package on npm thanks to [unpkg.com](https://unpkg.com), a popular and reliable CDN mirror of the npm registry. You can use this tool to learn more about the inner workings of your project's dependencies; find out how modules work, what they depend on, the size of specific imports as well as other useful metadata.
---
## Features
- 🔭 Navigable project directory listing
- 🎨 Syntax highlighted file contents
- 📝 Insights through static analysis
## Usage
To view a package or module in the browser with runpkg, prepend any unpkg url with: `r`. For example:
| Source | URL |
| ------ | ---------------------------------------------------------------------------------------------- |
| unpkg | [`https://unpkg.com/[email protected]/index.js`](https://unpkg.com/[email protected]/index.js) |
| runpkg | [`https://runpkg.com/[email protected]/index.js`](https://runpkg.com/[email protected]/index.js) |
You will be redirected to runpkg which will display the relevant package and file. You can navigate around the package using the 'Package' panel which contains a directory listing. The 'File' tab will also display any information uncovered during static analysis.
> Note if browsing a directory then runpkg will ignore the trailing `/` and take you to the entry point.
## Development
See [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on how to run this project locally, contribute, and to see our code of conduct.
## Local URLs
As we're not using Netlify to redirect URLs locally, you have to pass in the package or file part of the request in as a search param. Notice the `?` in the local URL. For example:
| Source | URL |
| --------- | -------------------------------------------------- |
| unpkg | `https://unpkg.com/[email protected]/index.js` |
| localhost | `http://localhost:8080/[email protected]/index.js` |
## Browsers Supported
| Browser | Supported | Versions |
| ----------------- | --------- | ----------- |
| Chrome | Yes | 73+ |
| Chrome (Android) | Yes | 73+ |
| Firefox | Yes | 66+ |
| Firefox (Android) | Yes | 66+ |
| Safari | Yes | 11+ |
| Safari (iOS) | Yes | 11+ |
| Opera | Yes | 59+ |
| Edge (Blink) | Yes | Dev, Canary |
| Edge (EdgeHTML) | No | |
| IE 11 | No | |
## Testing
We're currently doing end to end tests via Cypress, you can run them using the following:
```bash
yarn test
# or
npm run test
```
## Maintenance Status
**Active:** Formidable is actively working on this project, and we expect to continue for work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.
## Licence
MIT
[maintenance-image]: https://img.shields.io/badge/maintenance-active-green.svg?color=brightgreen&style=flat