Quick Tutorial

How a user would work with SetSwipe.

This page uses the project READMEs and current app structure to summarize how SetSwipe is installed, launched, and used. Videos and screen recordings are not available yet.

1. Prepare the environment

Install Git and Node.js first. The frontend README also requires Expo CLI, plus Android Studio on Windows or Xcode on macOS.

  • Windows flow includes Java, Python, Expo dependencies, and Android emulator setup.
  • macOS flow includes Xcode command line tools, Simulator setup, and Expo startup.
  • Both flows use npm install and npx expo start to launch the mobile app.

2. Start the backend

The Django README covers backend setup: create a virtual environment, install requirements.txt, generate local settings, run migrations, and start the server.

  • Activate the Python environment.
  • Run pip install -r requirements.txt.
  • Refresh local hosts and update the frontend API base URL.
  • Run python manage.py migrate and python manage.py runserver 0.0.0.0:8000.

3. Sign in and reach the library

The mobile app uses token-based login, then routes users into the workout library for browsing, search, and filtering.

4. Create a workout

The workout creation screen supports solo and group modes with swipe-based, automatic, or manual creation. Group mode also lets the creator select friends first.

5. Run a collaborative swiping session

In group mode, invited users join a lobby that shows workout metadata and participants. Once the host starts, users swipe through sets until the workout is finalized.

6. Review history and profile data

After a workout is created or completed, users can review workout details, history, profile data, friends, and related profile features.

Watch tutorial status

The watch README describes a basic SwiftUI companion app for timers, reps, set progression, pause or resume, and ending a session. A fuller watch tutorial is still coming soon.