HRIStudio

A web platform for managing human-robot interaction studies, participants, and wizard-of-oz experiments.

Features

Role-based access control with granular permissions
Study management and participant tracking
Wizard-of-oz experiment support
Data collection and analysis tools
Secure authentication with Clerk
Real-time participant management
Study-specific data isolation

Tech Stack

Next.js - React framework with App Router
TypeScript - Static type checking
Clerk - Authentication and user management
Drizzle ORM - TypeScript ORM
PostgreSQL - Database
TailwindCSS - Utility-first CSS
Shadcn UI - Component library
Radix UI - Accessible component primitives
Lucide Icons - Icon system

Getting Started

Clone the repository:

git clone https://github.com/yourusername/hristudio.git

Install dependencies:
```
pnpm install
```
Set up environment variables:
```
cp .env.example .env
```
Set up the database:
```
pnpm db:push
```
Start the development server:
```
pnpm dev
```
Open http://localhost:3000 in your browser

Project Structure

src/
├── app/              # Next.js app router pages and API routes
├── components/       # React components
│   ├── ui/          # Shadcn UI components
│   └── ...          # Feature-specific components
├── context/         # React context providers
├── db/              # Database schema and configuration
├── hooks/           # Custom React hooks
├── lib/             # Utility functions and permissions
└── types/           # TypeScript type definitions

Development

Run pnpm db:studio to open the Drizzle Studio database UI
Use pnpm lint to check for code style issues
Run pnpm build to create a production build

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please read our Contributing Guide for details on our code of conduct and the process for submitting pull requests.

2.5 KiB Raw Permalink Blame History