Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance with README and features #2

Closed
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Die Hard Xmas

## Project Description

Die Hard Xmas is a fun and interactive web application that allows users to vote on whether they consider "Die Hard" to be a Christmas movie. The application is built using React and Convex, providing a seamless and engaging user experience.

## Setup Instructions

1. Clone the repository:
```sh
git clone https://github.com/akaday/die-hard-xmas.git
cd die-hard-xmas
```

2. Install dependencies:
```sh
npm install
```

3. Set up Convex:
```sh
npx convex dev
```

4. Start the development server:
```sh
npm run dev
```

5. Open your browser and navigate to `http://localhost:3000` to see the application in action.

## Usage Instructions

1. Open the application in your browser.
2. Vote on whether you think "Die Hard" is a Christmas movie by clicking the "Yes" or "No" button.
3. View the results of the poll in real-time.

## Features

- **Real-time Voting:** Users can vote on whether they consider "Die Hard" to be a Christmas movie, and the results are updated in real-time.
- **Interactive UI:** The application features a festive and interactive user interface with animations and decorations.
- **Responsive Design:** The application is designed to work seamlessly on both desktop and mobile devices.
- **Convex Integration:** The application uses Convex for managing the backend, providing a smooth and efficient experience.