Skip to main content

Documentation Index

Fetch the complete documentation index at: https://openwearables.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Get started in three steps

Get Open Wearables running locally and start integrating wearable device data.

​
Step 1: Set up your environment

Clone the Open Wearables repository to your local machine:
git clone https://github.com/the-momentum/open-wearables.git
cd open-wearables
Create environment files for both backend and frontend:Backend configuration:
cp ./backend/config/.env.example ./backend/config/.env
Edit ./backend/config/.env with your configuration. You’ll need to set up:
  • Database credentials
  • Redis/Celery broker settings
  • OAuth credentials for wearable providers (Garmin, Fitbit, etc.)
  • Secret keys for authentication
Frontend configuration:
cp ./frontend/.env.example ./frontend/.env
Edit ./frontend/.env with your frontend configuration:
  • VITE_API_URL - Backend API URL (default: http://localhost:8000)
Default credentials are provided in the .env.example files for local development.

​
Step 2: Start the application

For local development without Docker:Backend setup:
  1. Install dependencies using uv (recommended) or pip: 
    cd backend
uv sync
  2. Set up PostgreSQL and Redis locally
  3. Run database migrations: 
    alembic upgrade head
  4. Start the FastAPI server: 
    uvicorn app.main:api --reload
Frontend setup:
  1. Install frontend dependencies using npm: 
    cd frontend
npm install
  2. Start the frontend development server: 
    npm run dev
The frontend will be available at http://localhost:3000

​
Step 3: Make your first API call

Once the application is running, you can test it:
  1. Check server status: 
    curl http://localhost:8000/
    Should return: {"message": "Server is running!"}
  2. Create an API key: An admin account is automatically created on startup using the ADMIN_EMAIL and ADMIN_PASSWORD environment variables (defaults: admin@admin.com / your-secure-password). Use the admin panel at http://localhost:3000/ to log in and generate API keys.
  3. Seed sample data (optional): If you want test users and sample activity data: 
    make seed
  4. View API documentation: Open http://localhost:8000/docs in your browser to explore the interactive Swagger UI.
  5. Make requests: 
    # Use the API key to make authenticated requests
curl http://localhost:8000/api/v1/users \
  -H "X-Open-Wearables-API-Key: YOUR_API_KEY"

​
Next steps

API Reference

Explore all available API endpoints.

GitHub

View source code and contribute.
Need help? Check out our GitHub Discussions or open an issue on GitHub.