readme update

This commit is contained in:
Florian Baumann 2022-02-02 10:35:17 +01:00
parent 3061c00dbb
commit 605b9837b1
7 changed files with 88 additions and 7 deletions

BIN
imgs/add.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

BIN
imgs/cards.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 89 KiB

BIN
imgs/set.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 122 KiB

BIN
imgs/sets.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 100 KiB

BIN
imgs/stats.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

BIN
imgs/tops.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 208 KiB

View File

@ -1,5 +1,87 @@
# serra # serra
Serra is my personal Magic: The Gathering collection tool.
It uses a MongoDB and [Scryfall](https://scryfall.com).
## What Serra does
* tracks prices
* calculates statistics
* shows what cards/sets do best in value development.
## What Serra does not
* Does not give a shit about conditions (NM, M, GD...)
* Does not track if card is foil or not (may come in the future)
* Its not configurable to have Dollar/US Prices
# Quickstart
Spin up a MongoDB (you can use docker-compose)
docker-compose up -d
Add a card
./serra add usg/17
Start exploring :) (the more cards you add, the more fun it is)
# Usage
```
./serra
Usage:
serra add <cardid>... [--count=<number>]
serra remove <cardid>...
serra cards [--rarity=<rarity>] [--set=<setcode>] [--sort=<sort>]
serra card <cardid>...
serra tops [--limit=<limit>]
serra flops [--limit=<limit>]
serra missing <setcode>
serra set <setcode>
serra sets
serra update
serra stats
```
## Add
To add a card to your collection
![](https://github.com/noqqe/noqqe.de/blob/main/imgs/add.png
## Cards
Query all of your cards with filters
![](https://github.com/noqqe/noqqe.de/blob/main/imgs/cards.png
## Sets
List all your sets
![](https://github.com/noqqe/noqqe.de/blob/main/imgs/sets.png
## Set
Show details of a single set
![](https://github.com/noqqe/noqqe.de/blob/main/imgs/set.png
## Stats
Calculate some stats for all of your cards
![](https://github.com/noqqe/noqqe.de/blob/main/imgs/stats.png
## Tops
Show what cards/se gained most value
![](https://github.com/noqqe/noqqe.de/blob/main/imgs/tops.png
## Update
The update mechanism iterates over each card in your collection and fetches
its price. After all cards you own in a set are updated, the set value will
update. After all Sets are updated, the whole collection value is updated.
# Install # Install
go build . go build .
@ -11,14 +93,10 @@
* calculate biggest gaining cards (Up XX %!) * calculate biggest gaining cards (Up XX %!)
* display (+/-) % in sets overview * display (+/-) % in sets overview
* display (+/-) % in history views * display (+/-) % in history views
* Reserved List
* Mythic
# Cheatsheet Queries
# What its not
* Gives a shit about conditions (NM, M, GD...)
* If the card is foil
# Cheatsheet
Find cards that increased prices Find cards that increased prices
@ -49,6 +127,9 @@ Calculate what cards gained most value in percent
# MongoDB Operations # MongoDB Operations
A few commands that do backups and exports of your data inside of the docker
container.
Do a database dump Do a database dump
mongodump -u root -p root --authenticationDatabase admin -d serra -o /backup/ mongodump -u root -p root --authenticationDatabase admin -d serra -o /backup/