Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BTS-CM/beet_api
An ElysiaJS based API for generating Bitshares Beet wallet deeplinks
https://github.com/BTS-CM/beet_api
api astro bitshares bun elysiajs html javascript swagger typescript
Last synced: 3 months ago
JSON representation
An ElysiaJS based API for generating Bitshares Beet wallet deeplinks
- Host: GitHub
- URL: https://github.com/BTS-CM/beet_api
- Owner: BTS-CM
- License: mit
- Created: 2023-09-12T12:24:31.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-02T22:42:12.000Z (7 months ago)
- Last Synced: 2024-05-12T15:37:52.044Z (6 months ago)
- Topics: api, astro, bitshares, bun, elysiajs, html, javascript, swagger, typescript
- Language: TypeScript
- Homepage:
- Size: 1.72 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-bitshares - Beet API - An ElysiaJS API used by the Bitshares DEX Astro UI. (Libraries / Tools and Scripts)
README
# beet_api
An ElysiaJS based API for generating Bitshares Beet wallet deeplinks
First [install Bun](https://bun.sh/docs/installation) on your computer.
This API was developed using Linux on Windows via [WSL](https://learn.microsoft.com/en-us/windows/wsl/install).
Before running this Bitshares Beet API, you need to install the required packages:
```
bun upgrade
bun install
```
You then need to fetch the required data for the API to serve to the constructed UI.
You can either fetch it all in the one go (which might fail):
```
bun run refreshData
```
Or you can manually run each script:
For erasing existing data:
```
bun run eraseChainData
```
For fetching new data:
```
bun run fetchPools
bun run fetchAssets
bun run fetchDynamicData
bun run fetchIssuers
bun run fetchBitassetData
bun run fetchOffers
bun run fetchDeals
bun run fetchFees
```
With the required chain data in place, you can then fetch the example [Astro UI](https://github.com/BTS-CM/astro-ui) for the public folder:
```
bun run constructUI
```
The above UI is optional, you can create your own application UI which queries the elysia server.
You can now run the dev server:
`bun run dev`
And you can now compile the beet_api into a linux executable:
`bun run compile`
---
Once the elysia server is running, navigate to:
`http://localhost:8080/` to view the hosted web app
---
To run the compiled executable, run: `./beet_api` in the WSL/Linux terminal.