Banganza - by Ida and Tilde #124

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

Open

Idahel wants to merge 238 commits into Technigo:main from tildetilde:main

.gitignore

-Original file line number
+Diff line change
@@ -1,15 +1,22 @@
+    # Dependencies
     node_modules
-    .DS_Store
+    # Environment variables
     .env
     .env.local
     .env.development.local
     .env.test.local
     .env.production.local
+    # Build outputs
     build
+    dist
+    # Logs
     npm-debug.log*
     yarn-debug.log*
     yarn-error.log*
-    package-lock.json
+    # System files
+    .DS_Store
+    Thumbs.db

README.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,13 +1,48 @@
  
    # Final Project

    # Banganza

    Replace this readme with your own information about your project.

    Banganza is a multiplayer quiz game where teams drag and drop cards on a timeline.  

    Built with **React, TypeScript, and Node.js**.

    Start by briefly describing the assignment in a sentence or two. Keep it short and to the point.

    ---

    ## The problem

    ## Features

    - Intro animation with video

    - Category selector with icons

    - Drag & drop timeline gameplay

    - Admin panel to manage categories and items

    - Fully responsive & accessible design

    Describe how you approached to problem, and what tools and techniques you used to solve it. How did you plan? What technologies did you use? If you had more time, what would be next?

    ---

    ## View it live

    ## Example Data

    Example of an item that can be added via the admin panel:

    Every project should be deployed somewhere. Be sure to include the link to the deployed project so that the viewer can click around and see what it's all about.
      
    ```json

    {

      "id": "net-1",

      "name": "Dancing Baby",

      "label": "Year 1996",

      "value": 1996,

      "categoryId": "internet.phenomena.year"

    }

    ```

    ## Tech Stack

    **Frontend:** React 18, TypeScript, Tailwind, dnd-kit  

    **Backend:** Node.js, Express, MongoDB  

    **Other:** JWT auth, Netlify/Render deployment

    ## Run locally

    ```bash

    git clone https://github.com/username/project-final.git

    cd project-final

    npm install

    npm run dev

    ```

    ## Live Demo

    👉 Play Banganza [here]([url](https://banganza.netlify.app/))

    https://banganza.netlify.app/

backend/.eslintrc.json

-Original file line number
+Diff line change
@@ -0,0 +1,25 @@
+    {
+      "root": true,
+      "parser": "@typescript-eslint/parser",
+      "plugins": [
+        "@typescript-eslint"
+      ],
+      "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+      ],
+      "parserOptions": {
+        "ecmaVersion": 2022,
+        "sourceType": "module"
+      },
+      "rules": {
+        "@typescript-eslint/no-unused-vars": "error",
+        "@typescript-eslint/no-explicit-any": "warn",
+        "prefer-const": "error",
+        "no-console": "off"
+      },
+      "env": {
+        "node": true,
+        "es2022": true
+      }
+    }

backend/README.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,8 +1,148 @@
  
    # Backend part of Final Project

    # Backend API Server

    This project includes the packages and babel setup for an express server, and is just meant to make things a little simpler to get up and running with.

    A Node.js/Express/TypeScript backend server for the Banganza quiz application.

    ## Getting Started

    ## Architecture

    1.  Install the required dependencies using `npm install`.

    2.  Start the development server using `npm run dev`.
      
    The backend follows a clean, layered architecture:

    ```

    src/

    ├── config/          # Configuration files

    ├── controllers/     # Request handlers

    ├── middleware/      # Express middleware

    ├── models/          # Mongoose models

    ├── routes/          # API route definitions

    ├── services/        # Business logic services

    ├── types/           # TypeScript type definitions

    ```

    ## Installation

    1. Install dependencies:

    ```bash

    npm install

    ```

    2. Create a `.env` file

    3. Configure environment variables in `.env`:

    ```env

    MONGODB_URI=mongodb://localhost:27017/your_database

    PORT=8888

    NODE_ENV=development

    FRONTEND_URI=http://127.0.0.1:5173

    JWT_SECRET=your_secure_jwt_secret

    ADMIN_USERNAME=admin

    ADMIN_PASSWORD=secure_password

    ADMIN_EMAIL=admin@example.com

    ```

    ## Running the Server

    ### Development

    ```bash

    npm run dev

    ```

    ### Production

    ```bash

    npm run build

    npm start

    ```

    ### Database Seeding

    ```bash

    npm run seed

    ```

    ### Create Admin User

    ```bash

    npm run create-admin

    ```

    ## 🔧 Available Scripts

    - `npm run dev` - Start development server with hot reload

    - `npm run build` - Build TypeScript to JavaScript

    - `npm start` - Start production server

    - `npm run lint` - Run ESLint

    - `npm run lint:fix` - Fix ESLint issues

    - `npm run type-check` - Type check without building

    - `npm run seed` - Seed database with sample data

    - `npm run create-admin` - Create initial admin user

    ## API Endpoints

    ### Public Endpoints

    - `GET /` - Health check

    - `GET /health` - Detailed health status

    - `GET /api/quiz/categories` - Get all quiz categories

    - `GET /api/quiz/category/:categoryId/items` - Get all items for a category

    - `POST /api/quiz/check` - Check quiz answers

    ### Protected Endpoints (Admin)

    - `POST /api/admin/login` - Admin authentication

    - `GET /api/admin/profile` - Get admin profile

    - `POST /api/admin/logout` - Admin logout

    - `GET /api/admin/categories` - Get all categories

    - `POST /api/admin/categories` - Create category

    - `PUT /api/admin/categories/:id` - Update category

    - `DELETE /api/admin/categories/:id` - Delete category

    - `GET /api/admin/items` - Get all items

    - `POST /api/admin/items` - Create item

    - `PUT /api/admin/items/:id` - Update item

    - `DELETE /api/admin/items/:id` - Delete item

    ## Authentication

    Admin endpoints require JWT authentication. Include the token in the Authorization header:

    ```

    Authorization: Bearer <your_jwt_token>

    ```

    ## Response Format

    All API responses follow a consistent format:

    ### Success Response

    ```json

    {

      "success": true,

      "data": { ... },

      "meta": {

        "timestamp": "2024-01-01T00:00:00.000Z",

        "path": "/api/endpoint",

        "method": "GET"

      }

    }

    ```

    ### Error Response

    ```json

    {

      "success": false,

      "error": {

        "message": "Error description",

        "code": "ERROR_CODE",

        "details": { ... }

      },

      "meta": { ... }

    }

    ```

    ## Database Models

    ### Admin

    - Username, password, email

    - Active status and last login tracking

    ### Category

    - ID, name, description, question

    - Unit, sort order, source information

    ### Item

    - ID, name, value, label

    - Category reference and source

backend/data/categories/animals.json

-Original file line number
+Diff line change
@@ -0,0 +1,14 @@
+    {
+      "id": "animals.weight",
+      "name": "Animals",
+      "description": "Quiz about animal weights in kilograms",
+      "question": "Which animal weighs the most?",
+      "unit": "kg",
+      "unitVisible": true,
+      "sort": "desc",
+      "source": {
+        "name": "Wikipedia (largest animals, species pages)",
+        "url": "https://en.wikipedia.org/wiki/List_of_largest_organisms"
+      },
+      "version": 1
+    }

backend/data/categories/celebrities.json

-Original file line number
+Diff line change
@@ -0,0 +1,14 @@
+    {
+      "id": "celebrities.age",
+      "name": "Celebrities",
+      "description": "Oldest to Youngest Celebrities",
+      "question": "What year was the celebrity born in?",
+      "unit": "year",
+      "unitVisible": false,
+      "sort": "desc",
+      "source": {
+        "name": "",
+        "url": ""
+      },
+      "version": 1
+    }

backend/data/categories/countries.coastline.json

-Original file line number
+Diff line change
@@ -0,0 +1,14 @@
+    {
+      "id": "countries.coastline",
+      "name": "Coastlines",
+      "description": "Quiz about coastline lengths (km) for sovereign countries (CIA World Factbook methodology)",
+      "question": "Which country has the longest coastline?",
+      "unit": "km",
+      "unitVisible": true,
+      "sort": "desc",
+      "source": {
+        "name": "CIA World Factbook (2023 archive)",
+        "url": "https://www.cia.gov/the-world-factbook/about/archives/2023/field/coastline"
+      },
+      "version": 1
+    }

backend/data/categories/elements.json

-Original file line number
+Diff line change
@@ -0,0 +1,14 @@
+    {
+      "id": "elements.atomicnumber",
+      "name": "Elements",
+      "description": "Quiz about chemical elements and their atomic numbers",
+      "question": "Which element has the lowest atomic number?",
+      "unit": "",
+      "unitVisible": false,
+      "sort": "asc",
+      "source": {
+        "name": "IUPAC, Periodic Table",
+        "url": "https://en.wikipedia.org/wiki/List_of_chemical_elements"
+      },
+      "version": 1
+    }

backend/data/categories/games.json

-Original file line number
+Diff line change
@@ -0,0 +1,14 @@
+    {
+      "id": "games.releaseyear",
+      "name": "Console Games",
+      "description": "Quiz about release years of popular console games",
+      "question": "What year was the game released?",
+      "unit": "year",
+      "unitVisible": false,
+      "sort": "desc",
+      "source": {
+        "name": "Wikipedia, IGN, GameSpot",
+        "url": "https://en.wikipedia.org/wiki/List_of_best-selling_video_games"
+      },
+      "version": 1
+    }

backend/data/categories/internet.json

-Original file line number
+Diff line change
@@ -0,0 +1,14 @@
+    {
+      "id": "internet.phenomena.year",
+      "name": "Internet Phenomena",
+      "description": "Quiz about viral internet phenomena and the year they peaked",
+      "question": "Which internet phenomenon happened first?",
+      "unit": "year",
+      "unitVisible": false,
+      "sort": "asc",
+      "source": {
+        "name": "Wikipedia, Know Your Meme",
+        "url": "https://knowyourmeme.com/"
+      },
+      "version": 1
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Banganza - by Ida and Tilde #124

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Banganza - by Ida and Tilde #124

Are you sure you want to change the base?

Uh oh!

Banganza - by Ida and Tilde #124

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!