Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/windht/watcher

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/windht/watcher
Owner: windht
Created: 2022-02-15T14:27:17.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2022-09-04T07:51:25.000Z (almost 2 years ago)
Last Synced: 2024-01-30T04:46:43.077Z (5 months ago)
Language: TypeScript
Size: 2.16 MB
Stars: 58
Watchers: 2
Forks: 8
Open Issues: 0
Metadata Files:
- Readme: README.md

Lists

awesome-tauri - Watcher - API manager built for a easier use to manage and collaborate. (Applications / Networking)

README

        






Watcher, API manager built for a easier use to manage and collaborate.




[![Windows Support](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)](https://github.com/windht/watcher/releases) [![Ubuntu Support](https://img.shields.io/badge/Ubuntu-E95420?style=for-the-badge&logo=ubuntu&logoColor=white)](https://github.com/windht/watcher/releases) [![Mac Support](https://img.shields.io/badge/MACOS-adb8c5?style=for-the-badge&logo=macos&logoColor=white)](https://github.com/windht/watcher/releases)



---

# What is Watcher?

![Demo](screenshot.png)

An API manager built for a easier use to manage and collaborate on API calls. It is also a cross-platform application powered by the web that is being wrapped using [Tauri](https://tauri.studio) framework in which you can run Watcher on Windows, MacOS, or Linux without having much trouble. Some Watcher's features/roadmap in summary are:

- [x] Making Request (Of course!)

- [x] Directory Management

- [x] Workspace switch

- [x] Import from swagger

- [x] Import from postman

- [x] Environment Variables Feature

- [x] Sync/Share Feature (From [supabase](https://supabase.io/))

- [x] Tab Feature

- [x] Pre/Post request script

- [ ] Realtime Collaboration 

- [ ] Sync From more places!

- [ ] Import from more places!

- [ ] Flow Management

Watcher is currently under heavy development. You can give your suggestions and feedback on our Discussions page. If you feel comfortable in writing code using Typescript and Rust, we highly encourage you to contribute to this project.

## Installation

If you want to install Watcher on your system, you can download the installer for your operating system [on the release page](https://github.com/windht/watcher/releases). Please note that the current version is not stable yet, and you may encounter various bugs.

## Tech Stack

- React

- Chakra UI

- Mobx

- Tauri

- Synced Store + Yjs (For Collaboration)

## Development

If you want to run this project in your local system, please follow this guide:

0. We use `yarn` to manage package and run scripts.

1. Run `yarn install` to install dependencies.

2. Run `yarn start` to start the react app running on port 3000 by default.

3. Follow [this guide](https://tauri.studio/en/docs/getting-started/intro/#setting-up-your-environment) to set up Tauri environment

4. Run `yarn tauri dev`

## Sync Features

Watcher currently support storing the collection in the supabase cloud. (Can be turned on in the green cloud button). Although it is being stored in the cloud, the data is encrypted with a offline key. This makes the collection impossible to be decrypted. When you are sharing the collection, you are also giving out the offline key which makes it possible for others to decrypt the collection detail locally.

We are using [automerge](https://github.com/automerge/automerge) to handle the syncing of data between different clients.

## Collaboration (In Progress)

[yjs](https://github.com/yjs/yjs) and [yjs-webrtc](https://github.com/yjs/y-webrtc) is used to share and exchange the realtime states between clients.