Skip to content

Latest commit

 

History

History
107 lines (69 loc) · 3.47 KB

README.md

File metadata and controls

107 lines (69 loc) · 3.47 KB
Raw

logo

One-stop API management tool

TypeScript Nest Mongoose Rust Tauri Svelte Vite

📋 Table of Contents

  1. 🐦 What is Sparrow ?
  2. 🔨 Installation
  3. ❤️ How to Contribute ?
  4. 📨 Subscribe to our Newsletter
  5. ©️ License

🐦 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 must have the following installed on your machine :

Docker NODE NPM

Prerequisite:

# Clone the repository
git clone https://github.com/sparrowapp-dev/sparrow-api.git

# Move into the project directory
cd sparrow-api

# Install PNPM globally
npm i -g pnpm

# Create and setup environments file
cp .env.example .env

Docker Method

  • To install all services(mongo + kafka + api server) as docker containers, run:

    pnpm docker:up

  • To install individual services, run:

      pnpm docker:<SERVICE NAME>
    • pnpm docker:mongo - Runs only mongo in a docker container
    • pnpm docker:kafka - Runs only kafka in a docker container
    • pnpm docker:api - Runs only the api server

Non-Docker Method

# Install dependencies
	pnpm i

# Run App in development mode
	pnpm start:dev

Access swagger on localhost:

Go to http://localhost:{PORT}/api/docs

Default User for Login:

Sparrow creates a default user to help you get started quickly and easily.

Login Credentials:

[OPTIONAL] In case you want to remove the docker services, run the following command:

pnpm docker:down

❤️ How to Contribue ?

You can checkout Contributing Guidelines

📨 Newsletter

Subscribe to our newsletter by applying here!

©️ License

Sparrow comes under the GNU AFFERO GENERAL PUBLIC LICENSE. For more information, you can checkout LICENSE