LoGet Tracker

A simple tracker for the LoGet collectable cards for tourists in Japan. The official LoGet site is here.

Access the Tracker · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: twitter_handle, email_client, email, project_title, project_description

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

Feel free to uitilize the already existing webpage for your needs. However, if you wish to self-host, follow the steps below.

Prerequisites

We assume you are running on Ubuntu. As such, you will need to have the following set up:

• Python 3.6 or higher
• A Postgres database
• Apache, Nginx, or your favorite web server (we will assume you know how to set this up)
  • _SECURITY WARNING: In settings.py, we have set the allowed_hosts to ['_']. This is not secure and should be changed to your domain name, or you need to have your web server checking for hostname.*
• From a back-end standpoint, there are no logs. This is for privacy reasons and is deemed acceptable for this low-security project. However, you may want to set up logging for your own purposes.
• There are also no tests for this project. This is because the project's scope is simple and future changes are not forseen. However, you may want to set up tests for your own purposes.

Installation

1. Clone the repo

   git clone https://github.com/dscpsyl/loget-japan-tracker.git

2. Create a virtual environment and activate it

   python3 -m venv .venv && source .venv/bin/activate

3. Install the required packages

    pip install -r requirements.txt

4. Set up your environment variables in the Django project folder

   cd logettracker && touch .env

   You will need to set the following variables:

   DJANGO-SECRET-KEY

5. Setup your database connection. We want your Postgres to have a service named logetcardtrackerdb_service with the database name loget_tracker. In addition, create a .my_pgpass in the Django project folder to connect to your database. You can change how you want to connect to your database in the settings.py file.
6. Make the migrations

   python manage.py makemigrations tracker && python manage.py migrate

7. Create a superuser

   python manage.py createsuperuser

8. Populate your cards table with the scraper.

   cd ../logetscraper && python main.py

9. If you are deploying to a production environment, make sure to run the deploy checks. Otherwise, enable DEBUG and remove other restrictions in the settings.py file for your own convenience.

   python manage.py check --deploy
   python manage.py collectstatic

10. Finally, start the server

cd ../logettracker && python manage.py runserver

(back to top)

Usage

Usage is simple. Simply create an account on the website and login.

You will be redirected to the tracker page where you can select which cards you've already collected. Cards yet to be collected will be greyed out. You can also export your collection in the settings page. If at any time you wish to erase your existance from the site, you can delete your account in the settings page.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the AGPL-3.0 License. See LICENSE for more information.

(back to top)

Contact

(back to top)