https://github.com/devhau/speedtestpro
https://github.com/devhau/speedtestpro
Last synced: 16 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/devhau/speedtestpro
- Owner: devhau
- License: mit
- Created: 2023-06-15T16:19:30.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-15T16:28:06.000Z (almost 3 years ago)
- Last Synced: 2025-09-21T18:16:53.401Z (8 months ago)
- Language: TypeScript
- Size: 551 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# speedtestpro
**speedtestpro** is a Javascript library for non-blocking notifications and without jQuery. The goal is to create a simple core library that can be customized and extended.
## Demo
- Demo can be found at https://speedtest.hau.xyz
## Install
#### [npm](https://www.npmjs.com/package/speedtestpro)
```
npm install --save speedtestpro
```
#### [yarn](https://yarnpkg.com/en/package/speedtestpro)
```
yarn add speedtestpro
```
## Wiki and Change Log
[Wiki including Change Log](https://github.com/devhau/speedtestpro/wiki)
## Breaking Changes
#### Animation Changes
The following animations options have been deprecated and should be replaced:
## Quick Start
### 3 Easy Steps
For other API calls, see the [demo](https://speedtest.hau.xyz).
### Other Options
## Building speedtest
To build the minified and css versions of speedtest you will need [node](http://nodejs.org) installed. (Use Homebrew or Chocolatey.)
```
npm install -g gulp karma-cli
npm install
```
At this point the dependencies have been installed and you can build speedtest
- Run the analytics `gulp analyze`
- Run the test `gulp test`
- Run the build `gulp`
## Contributing
For a pull request to be considered it must resolve a bug, or add a feature which is beneficial to a large audience.
Pull requests must pass existing unit tests, CI processes, and add additional tests to indicate successful operation of a new feature, or the resolution of an identified bug.
Requests must be made against the `develop` branch. Pull requests submitted against the `master` branch will not be considered.
All pull requests are subject to approval by the repository owners, who have sole discretion over acceptance or denial.
## License
speedtest is under MIT license