diff --git a/README.md b/README.md index e215bc4..d005704 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,83 @@ -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). +# 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](https://nextjs.org/) - React framework with App Router +- [TypeScript](https://www.typescriptlang.org/) - Static type checking +- [Clerk](https://clerk.com/) - Authentication and user management +- [Drizzle ORM](https://orm.drizzle.team/) - TypeScript ORM +- [PostgreSQL](https://www.postgresql.org/) - Database +- [TailwindCSS](https://tailwindcss.com/) - Utility-first CSS +- [Shadcn UI](https://ui.shadcn.com/) - Component library +- [Radix UI](https://www.radix-ui.com/) - Accessible component primitives +- [Lucide Icons](https://lucide.dev/) - Icon system ## Getting Started -First, run the development server: +1. Clone the repository: + ```bash + git clone https://github.com/yourusername/hristudio.git + ``` -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev +2. Install dependencies: + ```bash + pnpm install + ``` + +3. Set up environment variables: + ```bash + cp .env.example .env + ``` + +4. Set up the database: + ```bash + pnpm db:push + ``` + +5. Start the development server: + ```bash + pnpm dev + ``` + +6. Open [http://localhost:3000](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 ``` -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +## Development -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +- 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 -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. +## License -## Learn More +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. -To learn more about Next.js, take a look at the following resources: +## Contributing -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. +Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests. \ No newline at end of file