@mocks-server/core/README.md

Pluggable mock server supporting multiple route variants and mocks

<p align="center"><a href="https://mocks-server.org" target="_blank" rel="noopener noreferrer"><img width="120" src="https://www.mocks-server.org/img/logo_120.png" alt="Mocks Server logo"></a></p>

<p align="center">
  <a href="https://github.com/mocks-server/main/actions?query=workflow%3Abuild+branch%3Amaster"><img src="https://github.com/mocks-server/main/workflows/build/badge.svg?branch=master" alt="Build Status"></a>
  <a href="https://codecov.io/gh/mocks-server/main"><img src="https://codecov.io/gh/mocks-server/main/branch/master/graph/badge.svg?token=2S8ZR55AJV" alt="Coverage"></a>
  <a href="https://sonarcloud.io/project/overview?id=mocks-server_main_core"><img src="https://sonarcloud.io/api/project_badges/measure?project=mocks-server_main_core&metric=alert_status" alt="Quality Gate"></a>
  <a href="https://www.npmjs.com/package/@mocks-server/core"><img src="https://img.shields.io/npm/dm/@mocks-server/core.svg" alt="Downloads"></a>
  <a href="https://renovatebot.com"><img src="https://img.shields.io/badge/renovate-enabled-brightgreen.svg" alt="Renovate"></a>
  <a href="https://github.com/mocks-server/main/blob/master/packages/core/LICENSE"><img src="https://img.shields.io/npm/l/@mocks-server/core.svg" alt="License"></a>
</p>

---

# Mocks Server Core

This package provides the plugabble core of the [Mocks Server][website-url] project.

Use it if you want to [start Mocks Server programmatically by yourself](https://www.mocks-server.org/docs/api/javascript), or even [create your own Mocks Server distribution](https://www.mocks-server.org/docs/integrations/javascript) with the plugins of your choice. If this is not the case, you would probably prefer using the [main distribution of the Mocks Server project][main-url].

## Documentation

Please refer to the [project documentation website][website-url]:

* [Overview](https://www.mocks-server.org/docs/overview)
* [Usage](https://www.mocks-server.org/docs/usage/basics)
* [Configuration](https://www.mocks-server.org/docs/configuration/how-to-change-settings)
* [API](https://www.mocks-server.org/docs/api/javascript)

[website-url]: https://www.mocks-server.org
[logo-url]: https://www.mocks-server.org/img/logo_120.png
[main-url]: https://www.npmjs.com/package/@mocks-server/main