Giter Club home page Giter Club logo

mocktail's Introduction

Mocktail

Docker Image Version (latest by date) Docker Image Size (latest by date) Docker Image Version (latest semver) GitHub release (latest SemVer including pre-releases) Docker Build CI Docker Pulls

Mocktail is completely free, 11mb, self-hosted, containerized mock server with a dashboard.

There are no limitations or restrictions unlike most mock servers. You can mock any request. Mock apis can be exported and imported.

Quickstart ๐Ÿš€ โ€ข Capabilities ๐Ÿ˜Ž

mocktail_gif

Quickstart

Helm โŽˆ

Deploy with Helm โŽˆ

youtube tutorial is being prepared.

$ helm repo add hhaluk https://huseyinnurbaki.github.io/charts/
$ helm install mocktail hhaluk/mocktail

****** Application url will be prompted. ******

Helm Upgrade Guideline

Keep in mind that sqlite solution is not persistent. A workaround is exporting data, then importing after the upgrade. I tried to move the apis.db under a directory to be able to mount the directory for persistency but couldn't make it work. Open a PR if you make it work :)

$ helm repo update hhaluk
$ helm upgrade mocktail hhaluk/mocktail

****** Application url will be prompted. ******

See values.yaml at https://github.com/Huseyinnurbaki/charts under hhaluk/mocktail for customized deployment.

Docker ๐Ÿณ

Run Mocktail in a docker container ๐Ÿณ See Youtube Tutorial

$ docker run -p 4000:4000 -d hhaluk/mocktail:2.0.1

See "stable-version" tag at the beginning of this file to install the latest stable version.

Go to localhost:4000 ๐Ÿƒ

Local Developement ๐Ÿƒ๐Ÿƒ

Running Backend ๐Ÿƒ

I prefer vscode for debug mode It's already configured. You can also use LiteIDE, GoLand, Delve directly. Up to you.

If you are just going to work on the Dashboard, running it in a container is also an option. Use the command under "Run Mocktail in a docker container"

Running Dashboard ๐Ÿƒ

$ cd mocktail-dashboard
$ yarn start 

Go to localhost:3001 ๐Ÿƒ

Capabilities

  • Generate mock apis for Get/Post/Put/Patch/Delete using the Generate tab.
  • Catalog tab lists added apis.
  • See api details by clicking details button of an api under Catalog tab.
  • Test added apis.
  • Remove unused apis.
  • Export search results to json.
  • Import exported json.

V2 Keynotes โœ…

  • NodeJS replaced with Go Fiber.
  • React Upgrade
  • Containerize Mocktail
  • Build Scripts (GitHub Actions)
  • Update Readme
  • Define deployment commands.
    • Docker
    • Kubernetes (Helm)

Upcoming Features ๐Ÿ”ฅ

  • Multiple DB Support
  • Graphql support
  • Exception Mocking

References

mocktail's People

Contributors

baumstern avatar huseyinnurbaki avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

mocktail's Issues

Feature Request: OpenAPI Yaml Generator

Would be great to have an OpenAPI yaml definition generator from the json response.

Also, may be nice to have that injected there to validate the json coming out.

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.