Sprout Track

A Next.js application for tracking baby activities, milestones, and development.

Screenshots

Mobile-first app for tracking your child's activities	Dark mode for late night feedings	Responsive design for larger devices
Quick entry for logging activities	Comprehensive searchable activity log	Calendar for tracking events and reminders
Secure login with IP-based lockout	User-friendly setup wizard

Live Demo

Try out Sprout Track at our live demo: https://demo.sprout-track.com

The demo environment is refreshed every 2 hours.

Demo Login Information

Family Manager Access:

• URL: https://demo.sprout-track.com/family-manager
• Password: admin

Family Access:

• URL: https://demo.sprout-track.com
• Available login IDs: 01, 02, 03 (1-3 ID's are randomly generated)
• PIN: 111222

The demo is populated with semi-realistic 🙃 test data spanning multiple families and several days of baby tracking activities.

Quick Docker Deployment

To deploy the latest version using Docker:

For image pulls:

x64:

docker pull sprouttrack/sprout-track:0.92.16x64

arm64:

docker pull sprouttrack/sprout-track:0.92.16arm64

Build locally

docker-compose up -d

Table of Contents

• Tech Stack
• Getting Started
  • Prerequisites
  • Quick Setup (Recommended)
  • Manual Setup (Alternative)
  • Default Security PIN
• Initial Application Setup
  • Setup Wizard
• Available Scripts
  • Next.js Server/Dev Scripts
  • Customizing Port Numbers
  • Database Scripts
  • Utility Scripts
  • Updating the Application
• Environment Variables

Tech Stack

• Next.js with App Router
• TypeScript
• Prisma with SQLite (/prisma)
• TailwindCSS for styling
• Docker for containerization (optional)

Getting Started

Prerequisites

• Git (to clone the repository)
• Node.js (v22+) and NPM (v10+)
• Bash shell (for running the setup script)

Quick Setup (Recommended)

1. Clone the repository:

git clone https://github.com/Oak-and-Sprout/sprout-track.git
cd sprout-track

2. If deploying to a restricted directory (like /var/www), set proper permissions:

# For standard web server directories like /var/www
sudo chown -R $(whoami):$(whoami) .
# Or specify your web server user (e.g., www-data)
# sudo chown -R www-data:www-data .

3. Give execute permissions to the scripts folder:

chmod +x scripts/*.sh

4. Run the setup script:

./scripts/setup.sh

This setup script will:

• Install all dependencies
• Generate the Prisma client
• Run database migrations
• Seed the database with initial data (default PIN: 111222)
• Build the Next.js application

After setup completes, you can run the application in development or production mode as instructed in the setup output.

Manual Setup (Alternative)

If you prefer to set up manually or the setup script doesn't work for your environment:

1. Ensure Node.js (v22+) and NPM (v10+) are installed

2. Install dependencies:

npm install

3. Generate Prisma client:

npm run prisma:generate

4. Run database migrations:

npm run prisma:migrate

5. Seed the database:

npm run prisma:seed

To run the development server:

npm run dev

To run the production server:

1. Build the application:

npm run build

2. Run the production server:

npm run start

Open http://localhost:3000 with your browser to see the result.

Default Security PIN

The default security PIN after setup is: 111222

Initial Application Setup

After installation, when you first access the application, you'll be guided through a setup wizard that helps you configure the essential settings for your Sprout Track instance.

Setup Wizard

The application includes a built-in Setup Wizard (src/components/SetupWizard) that walks you through the following steps:

1. Family Setup

   • Enter your family name and link/slug
   • On initial setup you can import data from a previous version (just import the old *.db file from the /db folder)

2. Security Setup

   • Choose between a system-wide PIN or individual caretaker PINs
   • For system-wide PIN: Set a 6-10 digit PIN
   • For individual caretakers: Add caretakers with their own login IDs and PINs
     • First caretaker must be an admin
     • Each caretaker needs a 2-character login ID and 6-10 digit PIN

3. Baby Setup

   • Enter baby's information (first name, last name, birth date, gender)
   • Configure warning times for feeding and diaper changes
   • Default warning times: Feed (2 hours), Diaper (3 hours)

The Setup Wizard ensures your application is properly configured with the necessary security settings and initial data before you start tracking your baby's activities.

Available Scripts

Next.js Server/Dev Scripts

• npm run dev - Start development server
• npm run build - Build for production
• npm start - Start production server
• npm run lint - Run ESLint

Customizing Port Numbers

By default, the application runs on port 3000. To change the port:

1. Open package.json in your preferred text editor
2. Locate the "scripts" section
3. Modify the "dev" and/or "start" scripts to include the -p flag followed by your desired port number:

"scripts": {
  "dev": "next dev -p 4000",  // Development server will run on port 4000
  "start": "next start -p 8080"  // Production server will run on port 8080
}

This change will persist across application updates. For Docker deployments, use the PORT environment variable as described in the Docker section.

Database Scripts

• npm run prisma:generate - Generate Prisma client
• npm run prisma:migrate - Run database migrations
• npm run prisma:seed - Seed the database with initial data
• npm run prisma:studio - Open Prisma Studio to view/edit database

Setup and Deployment Scripts

• ./scripts/setup.sh - Complete initial setup (Node.js check, dependencies, database, build)
• ./scripts/env-update.sh - Check and update environment configuration (creates ENC_HASH if missing)
• ./scripts/update.sh - Update application (git pull, prisma operations, build)
• ./scripts/deployment.sh - Full deployment process (backup + update + service management)
• ./scripts/backup.sh - Create a backup of the application and database
• ./scripts/service.sh {start|stop|restart|status} - Manage the application service

Test Data Generation Scripts

• ./scripts/generate-test-data.sh - Interactive test data generation with customizable parameters
• ./scripts/generate-test-data-automated.sh - Automated test data generation (for cron jobs/CI/CD)
• ./scripts/generate-test-data.js - JavaScript data generation logic

Database Migration Scripts

• ./scripts/family-migration.js - Migrate existing data for multi-family support
• ./scripts/family-update.sh - Update database after multi-family migration
• ./scripts/ensure-utc-dates-improved.js - Convert all database dates to UTC format

Updating the Application

1. Backup your database:
Before upgrading, it is recommended to back up your baby-tracker.db file. You can do this by downloading the file from the settings page in either the main app or the family manager pages.

2. For Docker deployments:

• Stop the old container.
• Pull the latest Docker image.
• Start the new container.
• Import your backed-up database file from the inital setup page. The import process will automatically handle any required database migrations or updates.

3. For local (non-Docker) builds:

• Run the deployment script:

  ./scripts/deployment.sh
  

  This script will handle all necessary updates and migrations. You do not need to re-import your database, as the script manages updates in place.

Environment Variables

The application can be configured using environment variables in the .env file. Here are the available options:

Variable	Description	Default	Example
DATABASE_URL	Path to the SQLite database	"file:../db/baby-tracker.db"	"file:/path/to/custom/db.sqlite"
SERVICE_NAME	Name of the systemd service	"baby-tracker"	"sprout-track"
AUTH_LIFE	Authentication token validity period in seconds	"86400" (24 hours)	"43200" (12 hours)
IDLE_TIME	Idle timeout before automatic logout in seconds	"28800" (8 hours)	"3600" (1 hour)
APP_VERSION	Application version	"0.9.0"	"1.0.0"
COOKIE_SECURE	Whether cookies require HTTPS connections	"false"	"true"
ENC_HASH	Encryption hash for admin password security	Auto-generated	64-character hex string

Automatic Environment Setup

The ./scripts/env-update.sh script automatically manages environment variables:

• Creates .env file if it doesn't exist
• Generates a secure ENC_HASH (64-character random hex) if missing
• Used during setup and deployment processes

Important Notes:

• DATABASE_URL: Changing this after initial setup requires migrating your data manually.
• AUTH_LIFE: Lower values increase security but require more frequent logins.
• IDLE_TIME: Determines how long a user can be inactive before being logged out.
• ENC_HASH: Automatically generated for admin password encryption; do not modify manually.
• COOKIE_SECURE:
  • Set to "false" to allow cookies on non-HTTPS connections (development or initial setup)
  • Set to "true" when you have an SSL certificate in place (recommended for production)
  • When set to "true", the application will only work over HTTPS connections