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.
To install this project, you must have the following installed on your machine :
Then, run the following commands :
# Clone the repository
git clone https://github.com/techdome-io/sparrow-api.git
# Move into the project directory
cd sparrow-api
# Install PNPM globally
npm i -g pnpm
# Setup required components locally - Mongo, Kafka (Wait for 3-5 minutes after running this command)
pnpm docker:up
# Insatll dependencies
pnpm i
# Copy .env file
cp .env.example .env
# Run App in development mode
pnpm start:dev
# Access swagger on localhost
Go to http://localhost/api/docs
#[OPTIONAL] In case you want to remove the local components, run the below command
pnpm docker:down
The above will start the app in development mode and watch for changes on local.
-
"pnpm docker:up" command will expose the below components on respective ports, make sure you have those ports free on your system
- 27017 (Mongo)
- 2181 (Zookeeper)
- 29092, 9092, 9101 (Kafka)
-
Wait for 3-5 minutes after running "pnpm docker:up", so that kafka can initiate properly.
You can checkout Contributing Guidelines
Subscribe to our newsletter by applying here!
Sparrow comes under the GNU AFFERO GENERAL PUBLIC LICENSE. For more information, you can checkout LICENSE