Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uni-arts-chain/uniscan
A NFT explorer https://uniscan.pro/
https://github.com/uni-arts-chain/uniscan
Last synced: about 2 months ago
JSON representation
A NFT explorer https://uniscan.pro/
- Host: GitHub
- URL: https://github.com/uni-arts-chain/uniscan
- Owner: uni-arts-chain
- License: mit
- Created: 2021-08-16T05:53:11.000Z (over 3 years ago)
- Default Branch: glide
- Last Pushed: 2022-01-27T09:11:50.000Z (almost 3 years ago)
- Last Synced: 2024-08-04T22:15:52.081Z (5 months ago)
- Language: Ruby
- Homepage:
- Size: 7.32 MB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- On-Chain-Investigations-Tools-List - Uniscan
README
# README
Uniscan is a NFT Explorer for blockchains.
## Dependences
1. Ruby
2. Ruby on Rails - Web framework
3. [Hotwire](https://hotwired.dev/) - An alternative approach to building modern web applications
4. MySQL
5. Redis
5. ImageMagick - Convert image, resize image, identify image
6. FFmpeg - Convert video to gif
7. [Alibabacloud OSS](https://www.alibabacloud.com/product/oss) - Online image storage and access service
8. [Sidekiq](https://sidekiq.org/) - Simple, efficient background processing for Ruby
## Architecture and components
### Web Server
Provide web pages for users to use.
### NFT trackers for blockchains
Track and get the NFT on the blockchains.
There are now trackers for Ethereum and Darwinia as examples.
### NFT Workers
A NFT worker is a long-running process.
It is responsible for collecting the NFT discovered by the tracker and storing it in the database.
The data from the tracker is packaged into a `sidekiq` message for delivery.
### NFT token_uri processor
It reads the token_uri of NFT from the database, and then obtains the metadata.
And, it will download and process the image from the metadata.
## Models
A model is a Ruby class that is used to represent data.
Additionally, models can have most of the application's logic.
1. {Account}
2. {Blockchain}
3. {Collection}
4. {Token}
5. {Property}
6. {TokenOwnership}
7. {Transfer}
The relationship between the models:
## Controllers
Controllers handle the incoming web requests and eventually respond with a rendered view.
1. {WelcomeController}
2. {TokensController}
3. {CollectionsController}
4. {AccountsController}
## Test
**You can also test in docker container.**
### Preparation
1. Install Ruby ~> 2.7.0
See [Installing Ruby](https://www.ruby-lang.org/en/documentation/installation/)
2. Install ImageMagick & FFmpeg
3. Download code
Download or clone the [code](https://github.com/uni-arts-chain/uniscan) to local, and go to the root directory.
4. Install Rubygems
```bash
bundle install
```
### Run all tests
```bash
rails test
```
### Run a single test file
```bash
rails test test/models/transfer_test.rb
```
## Docker
### Run
1. Run mysql and redis.
```
docker-compose up -d db redis
```
2. Create tables and generate seed data.
```
docker-compose run --rm uniscan rails db:migrate
docker-compose run --rm uniscan rails db:seed
```
3. Run services
```
docker-compose up -d parse_token_uri update_creator
docker-compose up -d eth_scan sidekiq uniscan
```
### Test
1. Run mysql if not running
```
docker-compose up -d db
```
2. Create test database
```
docker-compose run --rm uniscan_test rails db:create
docker-compose run --rm uniscan_test rails db:migrate
```
3. Run tests
```
docker-compose run --rm uniscan rails test
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/uni-arts-chain/uniscan.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Supported by web3 foundation
