redo of entire app

README.md

@@ -1,36 +1,47 @@
-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).
+# Next.js Workshop Project
 
-## Getting Started
+## running it locally
 
 First, run the development server:
 
 ```bash
 npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+Open [http://localhost:3000](http://localhost:3000) with your browser.
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+## Figma Design page:
+[The figma design](https://www.figma.com/design/aD2uqt6nOnxRnH8LhOzztD/PE-Treasure-Hunt-Design?node-id=0-1&t=qVGjYO9k4xWNhjuw-1)
 
-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.
+## Expected features for the app.
+- Record team names – Must have.
+- Record names of team members – Could have.
+- A start button to initiate the treasure hunt, which remains disabled until activated by an
+  admin or a specific time – Could have.
+- Display treasure hunt clues sequentially once started – Must have.
+- Store a minimum of 10 and a maximum of 20 clues centrally, to be displayed in the app –
+  Could have.
+- For each clue, provide options to mark as "Found" (QR code located) or "Pass" (QR code not
+  found) - Should have.
+- Allow QR code scanning, retrieve and display the associated value – Must have.
+- Store the captured value with a timestamp – Could have.
+- Display the number of clues completed, remaining clues, and time left throughout the hunt
+  – Could have.
+- Show a summary of completed clues, QR codes, and total time taken at the end of the hunt
+  – Could have.
+- Display an alert and prompt users to return to the venue if time runs out – Should have.
+- Disable all interactions after the allotted time expires – Could have.
+- Enable the CSM induction team to monitor the progress of all teams centrally – Could have.
+- Allow the CSM induction team to send messages to the winning teams, including rankings
+  and congratulatory notes for the top three teams – Could have. -- thinking of not actually having it... way too much work.
+- Allow the CSM induction team to configure the treasure hunt parameters centrally – Could
+  have. -> no clue what this means???
 
-## Learn More
 
-To learn more about Next.js, take a look at the following resources:
+## To learn next.js
+
+Next.js documentation:
 
 - [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.