https://github.com/5afe/claim-mobile-api
Mobile client gateway for claim token flow
https://github.com/5afe/claim-mobile-api
Last synced: about 1 month ago
JSON representation
Mobile client gateway for claim token flow
- Host: GitHub
- URL: https://github.com/5afe/claim-mobile-api
- Owner: 5afe
- Created: 2022-08-08T06:36:13.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-19T02:53:32.000Z (over 3 years ago)
- Last Synced: 2025-09-08T00:26:27.120Z (9 months ago)
- Language: Python
- Size: 6.77 MB
- Stars: 0
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# claim-mobile-api
Mobile client gateway for claim token flow
## Setup
Following steps will guide through initial creation of guardians and vestings database which is needed for the service to operate.
### Infura
[Infura](https://infura.io/) is used as web3 provider to communicate with the blockchain. You need to get an API key and create environmental variable `INFURA_PROJECT_ID`
```
export INFURA_PROJECT_ID=
```
### Populate data
Run bootstrap script to parse guardians from csv, resolve their addresses, and download their images. Images will be converted to JPG, resized keeping initial aspect ratio, and stored in three different sizes.
```
python bootstrap.py
```
### Run service
Start service by running
```
uvicorn app:app --reload
```
### Endpoints
By default swagger UI is accessible at
```
http://127.0.0.1:8000/docs
```
Redoc UI is accessible at
```
http://127.0.0.1:8000/redoc
```