TimeFit

Project Description

A compact framework for constructing time-based Just-In-Time Adaptive Interventions (JITAIs) that utilize the time of day and/or Fitbit data for intervention adaptation.

Note: This project is periodically updated. Watch the repository for updates.

Citation

If you use this software, please cite it as below. ```

Hung, P-Y, & Newman, M. W. (2025). TimeFit (Version 0.0.1) [Computer software]. https://github.com/MIACollaborative/time-fit

```

Getting Started

The current recommended way to use this framework is to fork the repository and write your own application in the /src/apps folder.

Install the basics

We use yarn as our package manager.

Yarn: https://yarnpkg.com/

Install MongoDB

Instructions: download MongoDB community edition

Create folder for storing data

On Mac, create /data/mdata under the home folder, or ~/data/mdata.

On Windows, create \data\db under the c disk, or c:\data\db.

Run MongoDB

In command line/terminal:

```bash

Mac: create ~/data/mdata folder first, and then run the following command in the terminal:

mongod --port 27017 --dbpath ~/data/mdata --replSet rs0 --bind_ip localhost

Windows: create C:\datea\db folder first, and then run the following command in the terminal:

mongod --port 27017 --dbpath "c:\data\db" --replSet rs0 --bind_ip localhost

```

Install MongoDB GUI

Downlaod MongoDB compass for database GUI (or use command line if you prefer)

Create Collections

You can create collections through MongoDB compass or command line.

• create a database named "time_fit"

Please reference /prisma/schema.prisma for a list of collections (everythign that starts with "model XYZ") to create within the database: * log * users * ...

Configure environment settings

Create a file named ".env" in the root of the project folder with the following content:

```bash

mongodb connection string

DATABASEURL="mongodb://localhost:27017/timefit?readPreference=primary&appname=MongoDB%20Compass&ssl=false&retryWrites=false"

for integration with Fitbit API

FITBITSUBSCRIPTIONVERIFICATIONCODE=[fitbit subscription verification code] FITBITCLIENTID=[fitbit client id] FITBITAUTHTOKEN=[fitbit authentication token] FITBITAUTH_CODE=[fitbit authorization code]

for using Mailjet service to send emails

MAILJETAPIKEY=[mailjet api key] MAILJETSECRETKEY=[mailjet secret key]

for using Twilio service to send SMS/MMS

TWILIOACCOUNTSID=[twilio account id] TWILIOAUTHTOKEN=[twilio authentication token]

```

Install dependency

Run the following command in the project folder.

```bash

yarn install

```

Configure Prisma (for database query)

In addition to the first time, everytime the database schema, /prisma/schema.prisma, is changed, run this command in the project folder.

In a temrinal:

```bash

npx prisma generate

```

Run the default sample application

In a temrinal:

```bash

yarn index

```

Usage examples

Example 1: Nudge users to take a break every 30 minutes during week days

Example 2: Nudge users to take a break every 30 minutes during week days if step count is too low

License

This project is open-sourced under the BSD 3-Clause License, allowing for free use, distribution, and modification with attribution.