README.md

One-stop API management tool

📋 Table of Contents

1. 🐦 What is Sparrow ?
2. 🔨 Installation
3. 👨‍💻 Recommended IDE Setup
4. ❤️ How to Contribute ?
5. 📨 Subscribe to our Newsletter

🐦 What is Sparrow ?

Sparrow is your next go to API development buddy which can help you test, debug, distribute better APIs while collaborating with your colleagues and making you a better programmer.

🔨 Installation

To install this project, you will need to have the following installed on your machine :

Install the above dependencies by heading over to the links below,

1. Node
2. Tauri
3. Yarn

Then, run the following commands :

# Clone the repo
git clone https://github.com/sparrowapp-dev/sparrow-app

# Move into the project root
cd sparrow-app
	
# Install dependencies and Husky hooks
yarn

# Copy .env.example to .env
cp .env.example .env
 
# Run the app in dev mode
yarn tauri dev

The above command will start the app in development mode and watch for changes on local.

👨‍💻 Recommended IDE Setup

VS Code + Svelte + Tauri + rust-analyzer.

❤️ How to Contribue ?

You can checkout Contributing Guidelines

📨 Newsletter

Subscribe to our newsletter by applying here!