MedChronos LogoBack to Home
Documentation
Complete Documentation

MedChronos Documentation

Everything you need to get started with MedChronos, from installation to advanced features. Comprehensive guides for medical professionals and developers.

Getting Started
Follow these steps to set up your MedChronos environment and start the application.

⚙️ Getting Started

Prerequisites

  • Node.js 18+
  • npm or yarn
  • Google Cloud SDK
  • Git

Environment Variables

Create a .env file in the root directory by copying the .env.example template:

cp .env.example .env

Then, populate the .env file with your actual credentials.
Important: Ensure your .env file is listed in .gitignore (it should be by default) and is never committed to version control.

The required variables are:

# Database
DATABASE_URL="postgresql://USER:PASSWORD@HOST:PORT/DATABASE?sslmode=require"

# Google Cloud
GOOGLE_APPLICATION_CREDENTIALS="./path-to-your-gcp-key.json" # e.g., ./medchronos-key.json
GCP_PROJECT_ID="your-gcp-project-id"
GCS_BUCKET_NAME="your-gcs-bucket-name"

# Vertex AI (Location might be needed for other Vertex services)
VERTEX_AI_LOCATION="us-central1" 

# Gemini API
GEMINI_API_KEY="your-gemini-api-key"

# Application URL (Optional, but recommended for some features like PDF export if absolute URLs are needed)
# The base URL of your deployed application (e.g., http://localhost:3000 for local development)
# NEXT_PUBLIC_APP_URL="http://localhost:3000"

Installation & Running Locally

  1. Clone the repository:
    git clone https://github.com/your-username/medchronos.git
    cd medchronos
  2. Install dependencies:
    npm install
  3. If on Windows, install Sharp specifically:
    npm install --os=win32 --cpu=x64 sharp
  4. Push database schema changes (if it's the first time or schema changed):
    npm run db:push 
    # or npx prisma db push
  5. Run the development server:
    npm run dev
    The application will be available at http://localhost:3000.
Need Help?

If you encounter any issues during installation, check our troubleshooting guide or reach out to our support team.