Skip to main content

Get Started

After you purchase and receive the source code for the project:

Prerequisites​

  • Node.js (v18 or higher recommended)
  • npm (comes with Node.js)

Installation​

1. Environment Configuration​

First, set up your environment variables by copying the example file:

cp .dev.vars.example .dev.vars

Generate a secure random string for BETTER_AUTH_SECRET (you can use tools like openssl rand -base64 32).

npx wrangler d1 create schedulehost-cf-d1

Then update d1_databases in wrangler.jsonc with the database information. (database_name, database_id)

2. Install Dependencies and Setup​

npm install            # Install all project dependencies
npm run db:migrate:dev # Run database migrations for development
npm run dev            # Start the development server

Visit http://localhost:3000 to view the app.

Getting Started​

  1. Sign up on the login page to create your account.
  2. Check the terminal output for the email verification link.
  3. Click the verification link to activate your account and access the dashboard.
  4. Create an organization to manage your projects.
  5. Create your first project within the organization.
  6. Start creating scheduled notifications (schedule tasks) for your project.

Core Data Structure​

┌───────────────┐      ┌───────────────┐      ┌───────────────┐
│ Organization  │─────▶│   Project     │─────▶│ ScheduleTask  │
└───────────────┘      └───────────────┘      └───────────────┘

The application follows an organization-based structure where:

  • Organizations can have multiple projects
  • Projects belong to one organization and can have multiple schedule tasks
  • Schedule Tasks are the notification items that can be scheduled or permanent