The Wayback Machine - https://web.archive.org/web/20201114090317/https://github.com/amilajack/compat-db
Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
img
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

compat-db

๐Ÿ›  Status: In Development

compat-db is currently in development. It's on the fast track to a 1.0 release, so we encourage you to use it and give us your feedback, but there are things that haven't been finalized yet and you can expect some changes.

Build Status NPM version npm

A browser API compatibility database

What is compat-db?

Understand compat-db in 5 minutes

Goals

  • Automate browser compatibility testing of APIs
  • Be a drop-in replacement for caniuse-db
  • Provide a node API for finding compatibility records

Installation

npm install compat-db

Development Setup

git clone https://github.com/amilajack/compat-db.git
cd compat-db
yarn

# Create your `.env` file
# โš ๏ธ  Make sure to add your saucelabs keys to your `.env` file โš ๏ธ
cp .env.example .env

# Migrate the sqlite (the default) or mysql database
yarn migrate

# Build the compatibility database to ./lib/all.json
# ๐Ÿ’ก You can limit the amount of tests that you run by setting the following ENV's
# PROVIDERS_INDEX_START=0 PROVIDERS_INDEX_END=10 in your `.env` to run the first
# 10 tests
yarn build-compat-db

# Run tests
yarn test

# Serve the front-end browser UI for compat-db
yarn view-compat-db

Support

If this project is saving you (or your team) time, please consider supporting it on Patreon ๐Ÿ‘ thank you!

Roadmap

See the roadmap wiki

Related

About

A browser API compatibility database

Topics

Resources

License

Packages

No packages published
You canโ€™t perform that action at this time.