Skip to content
A browser API compatibility database
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode Post Checks Implementation (#47) Mar 6, 2017
compat-tests
flow-typed/npm
img
site
src
test
.editorconfig
.env.example
.eslintignore
.flowconfig
.gitignore upgrade all deps to latest semver, initial working tests (#101) Mar 5, 2019
.travis.yml
LICENSE
README.md add blog post to readme May 12, 2019
docker-compose.yml
package.json Update dependency flow-bin to ^0.98.0 May 1, 2019
wdio.conf.js
yarn.lock Update dependency flow-bin to ^0.98.0 May 1, 2019

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

You can’t perform that action at this time.