README.md

Stellar Wrapped API

A Spotify-style wrap for what a wallet has done on-chain throughout the year, built using Node.js, Express, and Mongoose.

Quick Start

Clone the repo:

git clone --depth 1 https://github.com/0xbhvn/stellar-wrapped-api.git
cd stellar-wrapped-api

Install the dependencies:

yarn install

Set the environment variables:

cp .env.example .env

# open .env and modify the environment variables (if needed)

Run the application:

yarn dev

API Documentation

To view the list of available APIs and their specifications, run the server and go to http://localhost:3000/v1/docs in your browser. This documentation page is automatically generated using the swagger definitions written as comments in the route files.

Contributing

Contributions are more than welcome! Please check out the contributing guide.

License

MIT