freemocap

# SPECIAL INSTRUCTIONS FOR THE `/development` BRANCH 

## Installation
### Python server
0. Install `uv` 
   - https://github.com/astral-sh/uv?tab=readme-ov-file#installation
1. clone the repo 
   - `git clone https://github.com/freemocap/freemocap`
2. Change directory to the repo: 
   - `cd freemocap`
3. **Change to the `development` branch:**
   - `git switch development`
4. Create virtual environment: 
   - `uv venv` 
5. Activate virtual environment
   - Windows: `.venv/bin/activate`
   - Mac/Linux: `source .venv/bin/activate`
6. Install dependencies
  - `uv sync` — installs skellytracker with NVIDIA GPU acceleration on Windows/Linux, or CPU-only on macOS, automatically
  - No supported GPU on Windows/Linux? Force the CPU-only build instead: `uv sync --no-default-groups --group cpu`
### React GUI
0. Install Node.js
   - https://nodejs.org/en/download/
1. Change directory to the `freemocap-ui` folder 
   - `cd freemocap-ui`
2. Install dependencies
   - `npm install`

## Run the FreeMoCap application in development mode 
1. Start the Python Server:
   - `python freemocap/__main__.py`
   - The server should start on `http://localhost:8005`
2. Start the React GUI:
   - `npm run dev`
   - An Electron window should pop up with the FreeMoCap GUI


## Build the FreeMoCap application 
(NOTE - This is not necessary for development, and does not handle the Python server yet)
1. Change directory to the `freemocap/freemocap-ui` folder
   - `npm run build`
   - The build will be in the `freemocap/freemocap-ui/releases` folder
---
---
# STANDARD README CONTINUES BELOW
___
___
___
<p align="center">
    <img src="https://github.com/freemocap/freemocap/assets/15314521/da1af7fe-f808-43dc-8f59-c579715d6593" height="240" alt="Project Logo">
</p> 


<h3 align="center">The FreeMoCap Project</h3>
<h4 align="center"> A free-and-open-source, hardware-and-software-agnostic, minimal-cost, research-grade, motion capture
system and platform for decentralized scientific research, education, and training</h2>


<p align="center">

<a href="https://doi.org/10.5281/zenodo.7233714">
    <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.7233714.svg" alt=DOI-via-Zenodo.org>
  </a>

<a href="https://github.com/psf/black">
    <img alt="https://img.shields.io/badge/code%20style-black-000000.svg" src="https://img.shields.io/badge/code%20style-black-000000.svg">
  </a>

<a href="https://github.com/freemocap/freemocap/releases/latest">
        <img src="https://img.shields.io/github/release/freemocap/freemocap.svg" alt="Latest Release">
    </a>

<a href="https://github.com/freemocap/freemocap/blob/main/LICENSE">
        <img src="https://img.shields.io/badge/license-AGPL-blue.svg" alt="AGPLv3">
    </a>

<a href="https://github.com/freemocap/freemocap/issues">
        <img src="https://img.shields.io/badge/contributions-welcome-ff69b4.svg" alt="Contributions Welcome">
    </a>

<a href="https://github.com/psf/black">
    <img alt="https://img.shields.io/badge/code%20style-black