mockforme/README.md

MockForMe is a fast and simple mock API solution for CSR and SSR apps. Create mock APIs in 2 minutes with support for delays, conditional responses, public URLs, random data, variables, Faker, and postFunctions — all designed to boost developer productivi

# README #

mockforme npm package can be used to intercept APIs and return mock responses created by you on your personalized dashboard on [mockforme](https://www.mockforme.com)

### [Mockforme Documentation](https://docs.mockforme.com)

### How to set up? ###

#### Prerequisites ####
* Register and login on [https://www.mockforme.com](https://www.mockforme.com)
* Generate client access token from: https://dashboard.mockforme.com/user/token

#### Installation ####
Install the package using npm or yarn: 
```
npm install mockforme --save
OR
yarn add mockforme
```


### How to use? ###

 ### CLIENT SIDE INTEGRATION
 * Import the package in your code for client side
	```
	import { mockforme } from 'mockforme';
	```
 * Initialize the SDK using Access Token (Generate access token [here](https://dashboard.mockforme.com/user/token))
	```
	mockforme('ACCESS_TOKEN').run();
	```

 * You can also access mockforme object in your browser from window object: 
	```
	console.log(window.mockforme);
	```
	And initialize it directly from window:
	```
	window.mockforme('ACCESS_TOKEN').run();
	```

 * You can also directly use mockforme through script file using jsdelivr CDN.
	```
	<script src="https://cdn.jsdelivr.net/npm/mockforme@latest/dist/mockforme.client.umd.js"></script>

	<script>
		console.log(window.mockforme);
		window.mockforme('ACCESS_TOKEN').run();
	</script>
	```

### SERVER SIDE INTEGRATION
 * Import the package in your code for server side
	```
	import { mockforme } from 'mockforme/server';
	```
 * Initialize the SDK using Access Token (Generate access token [here](https://dashboard.mockforme.com/user/token))
	```
	mockforme('ACCESS_TOKEN').run();
	```

## Example
[https://codesandbox.io/p/sandbox/wizardly-gagarin-smlf7z](https://codesandbox.io/p/sandbox/wizardly-gagarin-smlf7z)

## About Us
[https://www.mockforme.com](https://www.mockforme.com) is one of the many ways to mock your APIs. But it's SIMPLE.

 - **Easy to mock APIs:** Run your flows easily; minimize dev and testing effort
 - **User friendly:** Simple and easy to use; rich and powerful features
 - **Easy Integration:** The easiest integration ever; works like a charm

### Who do I talk to? ###
For queries, email us: [developer@mockforme.com](mailto:developer@mockforme.com)