https://github.com/amilajack/compat-db

A browser API compatibility database
https://github.com/amilajack/compat-db

api caniuse compatibility database db

Last synced: about 1 month ago
JSON representation

A browser API compatibility database

• Host: GitHub
• URL: https://github.com/amilajack/compat-db
• Owner: amilajack
• License: mit
• Created: 2017-01-09T02:47:26.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-03-26T12:01:16.000Z (over 2 years ago)
• Last Synced: 2024-09-27T00:20:16.712Z (about 2 months ago)
• Topics: api, caniuse, compatibility, database, db
• Language: JavaScript
• Homepage:
• Size: 1.1 MB
• Stars: 63
• Watchers: 2
• Forks: 5
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
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](https://travis-ci.org/amilajack/compat-db.svg?branch=master&maxAge=2592)](https://travis-ci.org/amilajack/compat-db)

[![NPM version](https://badge.fury.io/js/compat-db.svg?maxAge=2592)](http://badge.fury.io/js/compat-db)

[![npm](https://img.shields.io/npm/dm/compat-db.svg?maxAge=2592)](https://npm-stat.com/charts.html?package=compat-db)

A browser API compatibility database

## What is compat-db?

[Understand compat-db in 5 minutes](https://amilajack.com/compat-db)

## Goals

* Automate browser compatibility testing of APIs

* Be a drop-in replacement for [caniuse-db](https://github.com/Fyrd/caniuse)

* Provide a node API for finding compatibility records

## Installation

```bash

npm install compat-db

```

## Development Setup

```bash

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](https://github.com/amilajack/compat-db/wiki/Roadmap)

## Related

* [eslint-plugin-compat](https://github.com/amilajack/eslint-plugin-compat)

* [ast-metadata-inferer](https://github.com/amilajack/ast-metadata-inferer)