Skip to content

README.md

Latest commit

 

History

History
33 lines (20 loc) · 1.13 KB

README.md

File metadata and controls

33 lines (20 loc) · 1.13 KB
Raw

PromoShock Backend

PromoShock Backend is a Python project for indexing information stored on BNB for TicketFactory and PromoFactory contracts. Powered by FastAPI and SQLAlchemy.

This indexer can be implemented in the backend of streaming platforms for tracking the availability of NFT tickets for stream access, as well as on the website of any store that runs promotions on our site. For this, both the streaming platform and the store must have the functionality of wallet connection integrated in any convenient implementation for the service.

Installation

Use pipenv to run and install the project.

pipenv install

Start the server

pipenv run uvicorn server.fast_api:app --reload --host 0.0.0.0 --log-config log_conf.yaml

Use docker

Alternatively you can use docker-compose to start necessary services for local development. Use docker-compose.yaml located at root of the project and run:

docker-compose up -d

The server should be reacheable through 5005 port.

OpenAPI

With FastAPI you can view OpenAPI schema by calling http://localhost:5005/docs.