Roadtrip Word App

A fun word game application built with React, TypeScript, and Vite.

Overview

This app is designed to make road trips more entertaining by providing word-based games and challenges that passengers can play together.

How to play

Open the game in a browser, choose the length of your round, and click the button next to start game to randomly select a subject and a letter. Click start game and shout out as many things that match the subject and start with the letter as you can in the time. Each time you get one, click on the subject or letter to add to your score

Tech Stack

• React 18
• TypeScript
• Vite
• ESLint for code quality
• [Add additional technologies as they are implemented]

Getting Started

Prerequisites

• Node.js (v18 or higher)
• npm or yarn

Installation

# Clone the repository
git clone [your-repository-url]

# Navigate to the project directory
cd roadtrip-word-app

# Install dependencies
npm install

# Start the development server
npm run dev

Development

# Run tests
npm run test

# Build for production
npm run build

# Preview production build
npm run preview

Project Structure

roadtrip-word-app/
├── src/
│   ├── components/    # React components
│   ├── hooks/        # Custom React hooks
│   ├── pages/        # Page components
│   ├── styles/       # Global styles
│   └── utils/        # Utility functions
├── public/           # Static assets
└── tests/           # Test files

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

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