diff --git a/README.md b/README.md index 5b85063..e839710 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,13 @@ ## running it locally -First, run the development server: + +- delete the `.next` folder if you have one as there is an issue where it takes too long to build it that way. + +- run the development server: ```bash -npm i +npm i --legacy-peer-deps npm init npm run dev ``` @@ -15,11 +18,15 @@ Open [http://localhost:3000](http://localhost:3000) with your browser. ## Figma Design page: [The figma design](https://www.figma.com/design/aD2uqt6nOnxRnH8LhOzztD/PE-Treasure-Hunt-Design?node-id=0-1&t=qVGjYO9k4xWNhjuw-1) -## Expected features for the app. +## Tasks that are done - 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. +- Disable all interactions after the allotted time expires – Could have. + +## Tasks that need to be done + - 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. @@ -32,14 +39,51 @@ Open [http://localhost:3000](http://localhost:3000) with your browser. - 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. + +# 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??? + +# Admin Account +The admin login for this currently is: + +username: `administrator` + +password: `admin` + + ## To learn next.js Next.js documentation: