soconnor/personal-website
1
0
Fork 0
mirror of https://github.com/soconnor0919/personal-website.git synced 2025-12-15 08:14:43 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Sean O'Connor
2024-10-27 11:12:24 -07:00
parent d15c93d38e
commit 570a441dcb
3 changed files with 37 additions and 1022 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
README.md
View File

@@ -1,80 +1,61 @@
# HRIStudio
# Personal Website
HRIStudio is a web-based platform designed to streamline the design, execution, and analysis of Wizard-of-Oz (WoZ) experiments in Human-Robot Interaction (HRI) studies. It offers an intuitive interface for experiment creation, real-time control and monitoring during experimental runs, and comprehensive data logging and playback tools for analysis and reproducibility.
A modern, responsive personal website built with Next.js, TypeScript, and TailwindCSS. Features a clean, professional interface for showcasing projects and experience.
## Features
- User-friendly graphical interface for designing WoZ experiments
- Visual programming environment with drag-and-drop functionality
- Real-time control and observation capabilities during live experiment sessions
- Comprehensive data logging and playback tools
- Integration with Robot Operating System (ROS) for various robotic platforms
- Collaborative workflow support with multiple user accounts and data sharing
- Responsive design optimized for all screen sizes
- Dark mode support
- PDF rendering for CV display
- Project showcase with filtering and sorting
- Built with modern web technologies
## System Requirements
## Tech Stack
- Node.js (version X.X.X or higher)
- npm (version X.X.X or higher)
- ROS (Robot Operating System)
- [Next.js](https://nextjs.org/) - React framework for production
- [TypeScript](https://www.typescriptlang.org/) - Static type checking
- [TailwindCSS](https://tailwindcss.com/) - Utility-first CSS framework
- [Radix UI](https://www.radix-ui.com/) - Unstyled, accessible components
- [Lucide Icons](https://lucide.dev/) - Beautiful open source icons
## Installation
## Getting Started
1. Clone the repository:
```
git clone https://github.com/your-username/hristudio.git
```bash
git clone https://github.com/soconnor0919/personal-website.git
```
2. Navigate to the project directory:
```
cd hristudio
2. Install dependencies:
```bash
pnpm install
```
3. Install dependencies:
```
npm install
3. Start the development server:
```bash
pnpm dev
```
4. Set up environment variables:
Create a `.env.local` file in the root directory and add the necessary environment variables (e.g., database connection string, API keys).
5. Run the development server:
```
npm run dev
```
6. Open [http://localhost:3000](http://localhost:3000) in your browser to see the application.
4. Open [http://localhost:3000](http://localhost:3000) in your browser
## Project Structure
- `pages/`: Contains the Next.js pages
- `components/`: Reusable React components
- `public/`: Static assets
- `styles/`: CSS styles
- `lib/`: Utility functions and modules
- `api/`: API routes
- `ros/`: ROS interface and related components
## Usage
1. Create a new study in the Dashboard view
2. Design your experiment using the visual programming interface in the Design view
3. Execute the experiment using the Execute view
4. Analyze results and playback recorded data in the Playback view
For detailed usage instructions, please refer to the [User Guide](link-to-user-guide).
## Contributing
We welcome contributions to HRIStudio! Please read our [Contributing Guidelines](link-to-contributing-guidelines) for more information on how to get started.
```
src/
├── app/ # Next.js app router pages
├── components/ # React components
│ ├── ui/ # Reusable UI components
│ └── ... # Feature-specific components
├── lib/ # Utility functions and shared code
├── styles/ # Global styles
└── types/ # TypeScript type definitions
```
## License
This project is licensed under the [MIT License](link-to-license-file).
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contact
For questions or support, please contact [your-email@example.com](mailto:your-email@example.com).
## Acknowledgments
This project is being developed by Sean O'Connor and L. Felipe Perrone at Bucknell University. We would like to thank the robotics and HRI research community for their valuable insights and contributions.
Sean O'Connor
- Email: sean@soconnor.dev
- Website: [soconnor.dev](https://soconnor.dev)