Skip to content

Latest commit

 

History

History
108 lines (78 loc) · 3.19 KB

Readme.md

File metadata and controls

108 lines (78 loc) · 3.19 KB

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

To setup husky [pre-commit hook]:

  • npm run prepare

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

🏆 Contributors