https://github.com/sparrowapp-dev/sparrow-app

Your next-gen API testing and development tool.
https://github.com/sparrowapp-dev/sparrow-app

contribution hacktoberfest open-source

Last synced: 5 months ago
JSON representation

Your next-gen API testing and development tool.

• Host: GitHub
• URL: https://github.com/sparrowapp-dev/sparrow-app
• Owner: sparrowapp-dev
• License: agpl-3.0
• Created: 2024-01-02T08:20:46.000Z (over 1 year ago)
• Default Branch: development
• Last Pushed: 2024-11-22T13:26:48.000Z (5 months ago)
• Last Synced: 2024-11-22T13:37:32.319Z (5 months ago)
• Topics: contribution, hacktoberfest, open-source
• Language: Svelte
• Homepage: https://sparrowapp.dev
• Size: 193 MB
• Stars: 187
• Watchers: 4
• Forks: 49
• Open Issues: 184
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• jimsghstars - sparrowapp-dev/sparrow-app - Your next-gen API testing and development tool. (Svelte)

README

        


    

    

    

	
One-stop API management tool 


![screenshot](https://sparrowassets.blob.core.windows.net/publicassest/Sparrow-Dashboard-Readme.png)

![TypeScript](https://img.shields.io/badge/-TypeScript-black?style=for-the-badge&logoColor=white&logo=typescript&color=2F73BF)

![Nest](https://img.shields.io/badge/-NestJs-black?style=for-the-badge&logo=nestjs&color=E0234D)

![Mongoose](https://img.shields.io/badge/-MongoDB-black?style=for-the-badge&logoColor=white&logo=mongodb&color=127237)

![Rust](https://img.shields.io/badge/-Rust-black?style=for-the-badge&logoColor=white&logo=rust&color=000000)

![Tauri](https://img.shields.io/badge/Tauri-FFC131?style=for-the-badge&logo=Tauri&logoColor=white)

![Svelte](https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00)

![Vite](https://img.shields.io/badge/Vite-B73BFE?style=for-the-badge&logo=vite&logoColor=FFD62E)\

[![Quality Gate Status](https://sonar.techdomeaks.com/api/project_badges/measure?project=sparrow&metric=alert_status&token=sqb_aaefedc197c76ac808596f3e44d5e8d5b06ed348)](https://sonar.techdomeaks.com/dashboard?id=sparrow)

## 📋 Table of Contents

1. 🐦 [What is Sparrow ?](#what-is-sparrow)

2. 🔨 [Installation](#installation)

3. 👨‍💻 [Recommended IDE Setup](#recommended-ide-setup)

4. ❤️ [How to Contribute ?](#contributors)

5. 📨 [Subscribe to our Newsletter](#subscribe-to-our-newsletter)

## 🐦 What is Sparrow ?

Sparrow is your next go-to API development buddy which can help you test, debug, and 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 :

![NODE](https://img.shields.io/badge/-Node.js-black?style=for-the-badge&logoColor=white&logo=nodedotjs&color=339933)

![Yarn](https://img.shields.io/badge/-Yarn-black?style=for-the-badge&logoColor=white&logo=yarn&color=2C8EBB)

![Rust](https://img.shields.io/badge/-Rust-black?style=for-the-badge&logoColor=white&logo=rust&color=000000)

Check if you already have the prerequisites installed by running the below commands in your terminal

1. Node: node -v

2. Yarn: yarn check

3. Rust: rustc --version

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

1. [Node](https://nodejs.org/en)

2. [Tauri](https://tauri.app/v1/guides/getting-started/prerequisites)

3. [Yarn](https://classic.yarnpkg.com/lang/en/docs/install)

Then, run the following commands :

```bash

# 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 desktop app .env.example to .env

cp apps/@sparrow-desktop/.env.example apps/@sparrow-desktop/.env

# Copy web app .env.example to .env

cp apps/@sparrow-web/.env.example apps/@sparrow-web/.env

# Run the desktop app in dev mode

yarn desktop-start

# Run the web app in dev mode

yarn web-start

```

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

Follow [this](https://github.com/sparrowapp-dev/sparrow-api/blob/main/README.md) guide to set up the backend server.

## 👨‍💻 Recommended IDE Setup

[VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer).

## ❤️ How to Contribue ?

You can checkout [Contributing Guidelines](./docs/CONTRIBUTING.md)

## 📨 Newsletter

Subscribe to our newsletter by applying [here!](https://sparrows-newsletter.beehiiv.com/subscribe)