Skip to main content

​
Getting Started with Gradiant

This guide will help you set up and start using Gradiant. Follow these steps to get your environment ready and begin development.

​
Prerequisites

Before you begin, ensure you have the following installed:
  • Node.js (v18 or later)
  • pnpm (v8 or later)
  • AWS CLI (configured with appropriate credentials)
  • Docker (for local development)

​
Installation

  1. Clone the repository:
git clone https://github.com/gradiant/gradiant.git
cd gradiant
  1. Install dependencies:
pnpm install --frozen-lockfile
  1. Set up environment variables:
cp .env.example .env
Edit .env with your configuration values.

​
Configuration

​
Basic Setup

  1. Configure AWS credentials:
aws configure
  1. Set up the development database:
pnpm db:setup
  1. Initialize the development environment:
pnpm dev:init

​
Security Configuration

  1. Generate encryption keys:
pnpm security:init
  1. Configure HIPAA compliance settings:
pnpm hipaa:setup

​
Running the Application

  1. Start the development server:
pnpm dev
  1. Access the application:

​
Development Workflow

​
Code Structure

gradiant/
├── apps/
│   ├── web/          # Frontend application
│   ├── api/          # Backend API
│   └── docs/         # Documentation
├── packages/
│   ├── core/         # Shared core functionality
│   ├── ui/           # UI component library
│   └── config/       # Shared configuration
└── tools/            # Development tools

​
Key Commands

  • pnpm dev - Start development environment
  • pnpm test - Run tests
  • pnpm build - Build for production
  • pnpm lint - Run linting
  • pnpm format - Format code

​
Next Steps

​
Troubleshooting

​
Common Issues

  1. Database Connection Issues
    • Verify PostgreSQL is running
    • Check connection string in .env
    • Ensure proper permissions
  2. AWS Configuration
    • Verify AWS credentials
    • Check region settings
    • Confirm IAM permissions
  3. Development Server
    • Clear .next cache
    • Verify port availability
    • Check Node.js version

​
Getting Help