Code Monkey home page Code Monkey logo

mockman's Introduction

MockmanJS

npm version mockman licence mockman forks mockman stars mockman issues mockman pull-requests

mockman-js ยท Report Bug ยท Request Feature


๐Ÿค” About

๐Ÿš€ MockmanJS gives plug and play React Component to test your fake mock-backend APIs.

โšก Mocking Libraries such as MirageJS, JSON-Server etc. provide fake RESTful APIs. But sadly, you cannot test them without actually using them in your project.

๐ŸŒŒ Mockman is POSTMAN; but for Mock APIs.

๐Ÿคฉ Import Mockman in your project and get started!

You build Mock APIs, Mockman will handle the REST!


โฌ‡ Installation

Install Mockman by running:

npm i mockman-js

yarn add mockman-js

๐Ÿ› ๏ธ Usage

Import the component in your App

/*
we encourage to have a dedicated route called `/mock-api` on your frontend app where you can import Mockman and test them 
*/

import React from "react";
import Mockman from "mockman-js";
function MockAPI() {
  return (
    <div className="MockAPI">
      <Mockman />
    </div>
  );
}

export default MockAPI;

Import Styles

In your index.html, add the following:

<link
  rel="stylesheet"
  href="https://unpkg.com/mockman-js@latest/dist/style.css"
/>

You can always override the default styles by defining your custom css.

Color Scheme

Mockman currently supports colorScheme prop to define color scheme to Mockman component.

The colorScheme prop currently accepts two values - "standard" (default) and "dark".

<Mockman colorScheme="dark" />

๐Ÿ’– We love Contributions

  • mockBEE is truly Open Source. Any sort of contribution to this project are highly appreciated. Create a branch, add commits, and open a pull request.

  • Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to mockBEE.


๐Ÿ›ก๏ธ License

This project is licensed under the MIT License - see the LICENSE file for details.

mockman's People

Contributors

sohamsshah avatar nadaafarook avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.