Sylvan Library

SylvanLibrary is a database for storing and managing Magic: the Gathering cards and decks

Installation

Clone the repository

git clone https://github.com/marshl/sylvan_library.git

Navigate into the folder

cd ./sylvan_library

Create the python virtual environment and install th dependencies

pipenv install --dev

Activate the virtual environment

pipenv shell

Install node modules via npm

npm install --prefix ./sylvan_library/website/static

TO update the node modules run:

npm update --prefix ./sylvan_library/website/static --save

Database Initialisation

Install Postgres server and create a new database <database_name> with user and password that has access privileges to that database

Make a copy of sylvan_library/conf/.env.sample and call it sylvan_library/conf/.env

Edit .env and add in the information for the database you just created. Django will now be able to connect to that database.

Navigate into the folder that contains the manage.py file

cd ./sylvan_library

Run the django migrations

python manage.py migrate

Run the fetch_data command to download the latest mtgjson file:

python manage.py fetch_data

Update the database with the new dataset. This can take upwards of an hour, depending on hardware:

python manage.py update_database

Then update card rulings

python manage.py update_rulings

Then download all the card images from Scryfall

python manage.py download_card_images

If you want the non-English images too by specifiying the --all-languages flag (downloading all images can take several days, depending on bandwidth)

python manage.py download_card_images --all-languages

Running the Server

To run the server in debug mode use this command

python manage.py runserver

Projects

cards: The cards project is where the primary database models are stored, and is designed to be consumed by either an api or a website project
cardsearch: The cardsearch project contains classes for filtering cards using complex parameter trees
data_import: The data_import project contains commands and staging zones for importing data from external sources into the database
reports: The reports project contains Report and graph generation for offline data analysis
website: The website project contains views and controllers for rendering the sylvan_library front-end