Kaplan Desktop

1. Introduction
2. Installation
3. Links

Introduction

Hello. Welcome to the source repo for Kaplan Desktop. It’s been in the works for quite some time and it is exciting to go out and show it to fellow linguists. Please do not hesitate to reach out to [email protected] should you have any inquiries.

The documentation for the app itself is available here.

Installation

There are a few options:

1. Microsoft Store
2. .exe, .deb, and .rpm releases
3. Building from source (for advanced users)

Microsoft Store

The Microsoft Store page for Kaplan Desktop is located here.

.exe, .deb, and .rpm

The releases are available here.

NB: Ubuntu users may experience a bug where they cannot run the .deb file, unless they save it in a directory other than the default download directory.

Building from source

This is by far the most efficient method and the steps are more or less the same for all operating systems.

1. Install Python 3, if it’s not installed on your computer.

2. Get the source code from the repo.

3. Navigate to /backend/ and create a Python 3 virtual environment.

4. Activate the virtual environment.

5. Update pip and install the required Python libraries:

pip install --upgrade pip

pip install -r requirements.txt

pip install pyinstaller

6. Have pyinstaller build the backend Django server:

pyinstaller --name=backend --hidden-import backend.urls --distpath ../app --clean --noconfirm manage.py

7. Install yarn.

8. Navigate to /app/ and have yarn install the Nodejs libraries:

yarn install

9. (Windows-specific step) Remove the following line from package.json

"executableName": "kaplan-desktop",

10. Have yarn build the executable:

yarn make

11. The resulting executable(s) will be under /app/out/

Links:

1. Kaplan Homepage
2. Docs
3. Kaplan Desktop@Microsoft Store
4. Kaplan Desktop@Sourceforce