Skip to content

Commit

Permalink
Added License, also added gif onto the README
Browse files Browse the repository at this point in the history
  • Loading branch information
boyney123 committed Apr 18, 2019
1 parent 81ebfb0 commit 39af79b
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 22 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) David Boyne

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
54 changes: 32 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
<div align="center">

<h2>A tool to quickly mockout end points, setup delays and more...</h2>
<img alt="header" src="./header.png" />
<p>Mock APIs fast with real end points, no more mocked JSON files for your response.</p>
<p>Features: Hot reload on your API, UI to create, edit and delete end points, Chaos Engineering and more...</p>

[Read the Docs](https://mockit.netlify.com/) | [Edit the Docs](https://github.com/boyney123/mockit-docs)

_If you find this tool useful, feel free to buy me a ☕ 👍 -> [Buy a drink](https://www.paypal.me/boyney123/5)_

</div>

<hr/>

[![Travis](https://img.shields.io/travis/boyney123/mockit/master.svg)](https://travis-ci.org/boyney123/mockit)
[![CodeCov](https://codecov.io/gh/boyney123/mockit/branch/master/graph/badge.svg?token=AoXW3EFgMP)](https://codecov.io/gh/boyney123/mockit)
[![Netlify Status](https://api.netlify.com/api/v1/badges/6d5acca1-0959-4d92-a739-08f725fdc464/deploy-status)](https://app.netlify.com/sites/mockit/deploys)
[![MIT License][license-badge]][license]
[![PRs Welcome][prs-badge]][prs]

## The problem
<hr />

<img alt="header" src="./images/demo.gif" />
<h3>Mock APIs fast with real end points, no more mocked JSON files for your response.</h3>

[Read the Docs](https://mockit.netlify.com/) | [Edit the Docs](https://github.com/boyney123/mockit-docs)

</div>

<hr/>

# The problem

When building applications you often need to interact with services. When the services are not ready to be consumed you have a few options:

1. Mock out the response with a JSON file
2. Create a mock service yourself
3. Use MockIt.

## This solution
# This solution

This tool was designed to help developers quickly create end points for their applications. No need to create a server, just use docker and run this project locally. You can create, edit and manage routes to your API. Every change to the API will be reflected on the server and updated straight away.

Expand All @@ -41,31 +41,31 @@ More information about how it works, its features can be found on the docs.

[Read the docs and get started](https://mockit.netlify.com/)

## Getting Started
# Getting Started

_Make sure you have docker running_

```sh
git clone git@github.com:boyney123/mockit.git
```

Next go into `mockit` and run (You need to make sure Docker is running)

```sh
sh build-and-start.sh
cd mockit && sh build-and-start.sh
```

_This will create all the docker containers required to run this application._

Once everything is up and running go to [http://localhost:5000](http://localhost:5000) to see MockIt.

If you want to know how to use MockIt please [checkout the instructions](https://mockit.netlify.com/docs/getting-started/routes).
For instructions on how to use MockIt please see the [documentation](https://mockit.netlify.com/docs/getting-started/routes).

## Permissions

#### Permissions
_If you have any problems with permissions you might need to chmod the file_

```
chmod +x build-and-start.sh && ./build-and-start.sh
```

## Contributing
# Contributing

If you have any questions, features or issues please raise any issue or pull requests you like.

Expand All @@ -75,3 +75,13 @@ If you have any questions, features or issues please raise any issue or pull req
[license]: https://github.com/boyney123/react.explore-tech.org/blob/master/LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: http://makeapullrequest.com

# Donating

If you find this tool useful, feel free to buy me a ☕ 👍

[Buy a drink](https://www.paypal.me/boyney123/5)

# License

MIT.
Binary file added images/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes

0 comments on commit 39af79b

Please sign in to comment.