emoritzx/botw-tracker

The Legend of Zelda: Breath of the Wild progress tracker

botw-tracker

The Legend of Zelda: Breath of the Wild^TM Progress Tracker

Author: Evan Moritz

Description

This Django-based web application is a simple progress tracker for various aspects of the video game The Legend of Zelda: Breath of the Wild^TM.

Installation

1. Make sure the following software is installed on the target machine:

   • Python 3
   • Django (1.11.11 recommended)
   • (optional) sqlite3

2. Download the project from GitHub.

3. (optional) Create a database instance of your choice and update database settings in src/botwtracker/settings.py.

   By default, the project will use a sqlite3 instance in data/sqlite3.db.

4. (optional) If using the simple-signup app, update your email backend.

   # settings.py
   EMAIL_BACKEND = '...'
   

5. After cloning the project, run the configuration command:

   $ cd src
   $ python configure.py
   

   The configuration script will generate localized settings, prompting when necessary.

6. (optional) Create admin user:

   $ cd src
   $ python manage.py createsuperuser
   

   The admin user will have their own quest profile as well.

7. (optional) Run the server locally for testing:

   $ python manage.py runserver
   

8. Deploy application on development server.

   Django applications can be deployed on any server with Python/WSGI support.

License

Copyright (c) 2017, Evan Moritz.

botw-tracker is an open source software project released under the MIT License.
See the accompanying LICENSE file for terms.

Open Source Software

This project includes the following open source libraries:

• jQuery 3.2.1 Copyright jQuery Foundation. Released under MIT license, https://jquery.org/license/

• RequireJS 2.3.3 Copyright jQuery Foundation and other contributors. Released under MIT license, https://github.com/requirejs/requirejs/blob/master/LICENSE

• simple-signup Copyright (c) 2016 Simple is Better Than Complex Released under MIT license, https://github.com/sibtc/simple-signup/blob/master/LICENSE

References

• Django is a registered trademark of the Django Software Foundation.
• The Legend of Zelda: Breath of the Wild^TM is copyright (c) 2017, Nintendo.
• The Legend of Zelda, Wii U, and Nintendo Switch are trademarks of Nintendo.
• Python and PyCon are trademarks or registered trademarks of the Python Software Foundation.