ThinkerPal / anki-dhs

App for DHS Computing students to revise...Computing

Anki Revision App

This app is made for DHS computing students to revise their work

Grab the download here

This app is based on the client template found at buildingblocs/vuetify-todo-app. Major thanks to ThePyProgrammer for setting the template up

Project Checklist:

• Python executable for distribution
• Scripted compilation of python executable (integrate into npm run dist)
• Run app with pyinstaller's version of backend
• Move entire project over to js-based vue since we are not using typescript for this project
• Figure out how to include python backend in electron distribution
• Figure out codesigning and distribution (the actual npm run dist script)
• Compile for macOS
• Compile for Windows
• Compile for linux

Project setup

Before you start developing, run the following commands:

Windows

npm run win:setup

Linux/macOS

npm run setup

How to run the application locally for testing (with electron)

Windows

npm run win:dev

Linux/macOS

npm run dev

Alternative: To run the vuejs (web) version of the app, you need to run both the frontend and the backend as shown below

Windows

py backend/backend.py

In another window, run:

npm run serve

To build a release (building the electron app)

This makes an executable that you can that ship in the releases section. Do note that you need to compile on each architecture manually, and you may need an Apple Distrbution Certificate for compiling on macOS.

npm run build

macOS Compilation

To compile electron on macOS, make sure to include python2 path in compile command

Some parts of the electron codesigning process for this requires python2's reload function, so if you have a newer mac, it may no longer exist.

I recommend using pyenv to install python2. If you use pyenv, be sure to have python2 in your shell before building the electron app

pyenv shell 3.10.5/envs/anki-dist python2.7.18
PYTHON_PATH=`pyenv which python2` npm run build