Skip to content

Windows

Quick install instructions

Warning

python 3.12 is currently not supported

  1. Download and install Python 3.10 or Python 3.11 from the official Python website.
  2. Download and install Node.js from the official Node.js website. This will also install npm.
  3. Download the Talemate project to your local machine. Download from the Releases page.
  4. Unpack the download and run install.bat by double clicking it. This will set up the project on your local machine.
  5. Once the installation is complete, you can start the backend and frontend servers by running start.bat.
  6. Navigate your browser to http://localhost:8080

If everything went well, you can proceed to connect a client.

Additional Information

How to Install Python 3.10 or 3.11

  1. Visit the official Python website's download page for Windows at https://www.python.org/downloads/windows/.
  2. Find the latest version of Python 3.10 or 3.11 and click on one of the download links. (You will likely want the Windows installer (64-bit))
  3. Run the installer file and follow the setup instructions. Make sure to check the box that says Add Python 3.10 to PATH before you click Install Now.

How to Install npm

  1. Download Node.js from the official site https://nodejs.org/en/download/prebuilt-installer.
  2. Run the installer (the .msi installer is recommended).
  3. Follow the prompts in the installer (Accept the license agreement, click the NEXT button a bunch of times and accept the default installation settings).

Usage of the Supplied bat Files

install.bat

This batch file is used to set up the project on your local machine. It creates a virtual environment, activates it, installs poetry, and uses poetry to install dependencies. It then navigates to the frontend directory and installs the necessary npm packages.

To run this file, simply double click on it or open a command prompt in the same directory and type install.bat.

start.bat

This batch file is used to start the backend and frontend servers. It opens two command prompts, one for the frontend and one for the backend.

To run this file, simply double click on it or open a command prompt in the same directory and type start.bat.