Code Monkey home page Code Monkey logo

kabhamo / sharkio Goto Github PK

View Code? Open in Web Editor NEW

This project forked from oferlis/sharkio

0.0 0.0 0.0 18.96 MB

Sharkio is an API proxy for you development environments. It records all the requests that are sent to your API. It allows you to replay the requests easily. Generate types, documentation, test suites, And interact with your API using AI.

License: MIT License

Shell 0.61% JavaScript 11.74% TypeScript 83.86% CSS 0.68% HTML 0.47% SCSS 2.64%

sharkio's Introduction

Sharkio

🐳 What is Sharkio

Sharkio is a development tool for api developers. It is a proxy that records all the requests that are sent to your servers. And provides you with a dashboard to analyze all the traffic. Sharkio also provides the ability to repeat requests. Generate types for youre favorite language based on real data.

πŸ—ΊοΈ Roadmap

In the roadmap sharkio will support team functions. Also Sharkio will integrate with ChatGPT in order to allow easy use of api. Request automation. Api inconsistency alerting. Integration to Postman. Automatic CLI generation for your api with real data. Request mocking.

πŸ”– Features

Feature Name Available
Inspect traffic βœ…
Search βœ…
Filter βœ…
Repeat request βœ…
Typescript generator βœ…
JSON schema generator βœ…
Microservice support βœ…
Open api generator
Request mocks
ChatGPT integration
Save requests
Collections
Share requests

πŸ› οΈ How to use

  • npm install -g sharkio@latest
  • sharkio dashboard start
  • sharkio admin start
  • sharkio admin sniffers create --port 5100 --downstreamUrl http://localhost:3000

πŸš€ Getting started

  • npm i -g concurrently ts-node

For the backend

  • cd into traffic-sniffer.
  • npm install
  • npm run dev

For the frontend

  • cd into traffic-dashboard.
  • npm install
  • npm run dev

For both:

  • npm run dev ( in root directory )

πŸ—οΈ Architecture

image

πŸ“Έ / πŸŽ₯ Screenshots

Visual Demonstration: How to run the application?

Preview How To Use GIF
Preview UI interface Screenshot 2023-06-21 at 20 01 38 Screenshot 2023-06-26 at 12 32 47

⚑ Social links

πŸ‘©πŸ»β€πŸ’» Want to contribute?

  • Fork the repo, clone it to your local environment and start exploring the code.
  • Look for an issue, preferably from the next milestone list.
  • Ask to be assigned to the issue.
  • Got stuck? need an advice? find us in the Discord server.
  • Found a bug? πŸ› please open an issue.

🀝 Acknowledgement

sharkio's People

Contributors

idoband avatar idodav avatar noams24 avatar oferlis avatar shravan20 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.