Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adshao/ordinals-indexer
API server and index synchronizer for ordinals inscriptions
https://github.com/adshao/ordinals-indexer
brc-20 brc-721 ordinals
Last synced: 2 months ago
JSON representation
API server and index synchronizer for ordinals inscriptions
- Host: GitHub
- URL: https://github.com/adshao/ordinals-indexer
- Owner: adshao
- License: mit
- Created: 2023-05-31T15:51:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-31T13:48:18.000Z (over 1 year ago)
- Last Synced: 2024-10-12T20:29:53.490Z (3 months ago)
- Topics: brc-20, brc-721, ordinals
- Language: Go
- Homepage:
- Size: 321 KB
- Stars: 55
- Watchers: 3
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ordinals Indexer
Ordinals Indexer is an API server and index synchronizer for ordinals inscriptions. It provides a robust and efficient way to interact with and manage ordinals inscriptions data.
## Features
- Implements the [BRC-721](https://github.com/adshao/brc-721) protocol.
- Easily parse inscription content for other protocols, including ordinals domains and BRC NFTs.
- Provides a robust and efficient way to interact with and manage ordinals inscriptions data.
## Requirements
- It's recommended to run your own ordinals server before using this indexer.
- Create a database for the indexer to store data.
## Getting Started
Here are the steps to setup and run Ordinals Indexer:
### Init
Initialize the project:
```bash
make init
```
### Configuration
Copy the `configs/config_example.yaml` to `configs/config.yaml` and modify the configuration file as needed.
### Migrate Database
Use [atlas](https://atlasgo.io/) to apply the database schema to your database.
```bash
atlas migrate apply --dir 'file://internal/data/ent/migrate/migrations' --url 'postgres://test:test@localhost:5432/test'
```
> Note: replace the database URL with your own. You should migrate the database every time there is a new migration.
### Generate Code
Generate code for APIs, configs and database:
```bash
make all
```
### Build Binary
Build the binaries for the API server and syncer:
```bash
make build
```
### API Server
Run API server to start the indexer:
```bash
./bin/server -conf configs/config.yaml
```
### Syncer
Run syncer to start syncing data with the ordinals server:
```bash
./bin/sync -conf configs/config.yaml
```
## Documentation
You can find the complete API documentation [here](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/adshao/ordinals-indexer/main/openapi.yaml#/).
## Contributing
We welcome contributions from the community! Please check out our Contributing Guide for more details.
## Support
If you encounter any issues or have questions, please open an issue on this GitHub.
## License
Ordinals Indexer is licensed under the MIT License.
---
Let me know if you'd like me to fill in more specific details, or if there's any additional information you'd like me to include.