diff --git a/.github/preview1.jpg b/.github/preview1.jpg new file mode 100644 index 0000000..af217d6 Binary files /dev/null and b/.github/preview1.jpg differ diff --git a/.github/preview2.jpg b/.github/preview2.jpg new file mode 100644 index 0000000..b62760f Binary files /dev/null and b/.github/preview2.jpg differ diff --git a/.github/preview3.jpg b/.github/preview3.jpg new file mode 100644 index 0000000..9c2f307 Binary files /dev/null and b/.github/preview3.jpg differ diff --git a/README.md b/README.md index 250b303..69785c8 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,12 @@ Rahoot is a straightforward and open-source clone of the Kahoot! platform, allow > ⚠️ This project is still under development, please report any bugs or suggestions in the [issues](https://github.com/Ralex91/Rahoot/issues) +

+ Login + Manager Dashboard + Question Screen +

+ ## ⚙️ Prerequisites Choose one of the following deployment methods: @@ -33,7 +39,6 @@ Choose your deployment method: ### 🐳 Using Docker (Recommended) Using Docker Compose (recommended): - You can find the docker compose configuration in the repository: [docker-compose.yml](/compose.yml) @@ -53,6 +58,15 @@ docker run -d \ ralex91/rahoot:latest ``` +**Configuration Volume:** +The `-v ./config:/app/config` option mounts a local `config` folder to persist your game settings and quizzes. This allows you to: + +- Edit your configuration files directly on your host machine +- Keep your settings when updating the container +- Easily backup your quizzes and game configuration + +The folder will be created automatically on first run with an example quiz to get you started. + The application will be available at: - Web Interface: http://localhost:3000 diff --git a/config/game.json b/config/game.json index 0b4f9eb..74e47a5 100644 --- a/config/game.json +++ b/config/game.json @@ -1,4 +1,3 @@ { - "managerPassword": "PASSWORD", - "music": true + "managerPassword": "PASSWORD" } diff --git a/packages/web/README.md b/packages/web/README.md deleted file mode 100644 index e215bc4..0000000 --- a/packages/web/README.md +++ /dev/null @@ -1,36 +0,0 @@ -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). - -## Getting Started - -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. - -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. - -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. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [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.