Initial commit

Author: ModusOperandom

.devcontainer/devcontainer.json

@@ -0,0 +1,16 @@
+{
+  "name": "Python 3",
+  "image": "mcr.microsoft.com/vscode/devcontainers/python:3.13",
+  "forwardPorts": [8000],
+  "postCreateCommand": "bash ./.devcontainer/postCreate.sh",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "GitHub.copilot",
+        "ms-python.python",
+        "ms-python.debugpy",
+        "mongodb.mongodb-vscode"
+      ]
+    }
+  }
+}

.devcontainer/installMongoDB.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+# Install MongoDB
+wget -qO - https://www.mongodb.org/static/pgp/server-7.0.asc | sudo apt-key add -
+echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/7.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-7.0.list
+sudo apt-get update
+sudo apt-get install -y mongodb-org
+
+# Create necessary directories and set permissions
+sudo mkdir -p /data/db
+sudo chown -R mongodb:mongodb /data/db
+
+# Start MongoDB service
+sudo mongod --fork --logpath /var/log/mongodb/mongod.log
+
+echo "MongoDB has been installed and started successfully!"
+mongod --version
+
+# Run sample MongoDB commands
+echo "Current databases:"
+mongosh --eval "db.getMongo().getDBNames()"

.devcontainer/postCreate.sh

@@ -0,0 +1,5 @@
+# Prepare python environment
+pip install -r requirements.txt
+
+# Prepare MongoDB Dev DB
+./.devcontainer/installMongoDB.sh

.github/steps/1-protect-your-code.md

@@ -0,0 +1,173 @@
+# Step 1: Protect your code
+
+It's been a busy month at Mergington High! Your simple website for managing extra-curricular activities has really taken off. What started as a basic sign-up form for a few activities has grown into the go-to place for half the school activities. 📚✨
+
+Principal Martinez was so impressed with your work that they announced at the last staff meeting that ALL clubs should start using the website. While this is exciting, you're a bit nervous - the last thing you want is an accidental change breaking the system right before the big Fall Activities Fair! 😰
+
+When more teachers start helping with the Mergington High activities website, it's important to add some safeguards. Thankfully, GitHub provides several ways to protect your repository:
+
+1. **Repository Rulesets** - These provide safeguards to limit:
+
+   - Pushing code directly to important branches
+   - Deleting or renaming branches
+   - Force pushing (which can overwrite history)
+   - (and much more)
+
+1. **`.gitignore`** - This special file tells Git which files it should NOT track, like:
+
+   - Temporary files that your code creates while running
+   - Secret configuration files with sensitive information
+   - System files that other developers don't need
+
+> [!TIP]
+> Think of these settings like the editorial process of a school yearbook. Various student committees will take photos and write articles, then the yearbook president will make adjustments to make sure everything flows together properly. Finally, a teacher/advisor will sign off that all content is appropriate.
+
+## ⌨️ Activity: (optional) Get to know our extracurricular activities site
+
+<details>
+<summary>Show Steps</summary>
+
+In other exercise, we have been developing the Extracurricular activities website. You can follow these steps to start up the development environment and try it out.
+
+> ! **Important:** Opening a development environment and running the application is not necessary to complete this exercise. You can skip this activity if desired.
+
+1. Right-click the below button to open the **Create Codespace** page in a new tab. Use the default configuration.
+
+   [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/{{full_repo_name}}?quickstart=1)
+
+1. Wait some time for the environment to be prepared. It will automatically install all requirements and services.
+
+1. Validate the **GitHub Copilot** and **Python** extensions are installed and enabled.
+
+   <img width="300" alt="copilot extension for VS Code" src="https://github.com/user-attachments/assets/ef1ef984-17fc-4b20-a9a6-65a866def468" /><br/>
+   <img width="300" alt="python extension for VS Code" src="https://github.com/user-attachments/assets/3040c0f5-1658-47e2-a439-20504a384f77" />
+
+1. Try running the the application. In the left sidebar, select the **Run and Debug** tab and then press the **Start Debugging** icon.
+
+   <details>
+   <summary>📸 Show screenshot</summary><br/>
+
+   <img width="300" alt="run and debug" src="https://github.com/user-attachments/assets/50b27f2a-5eab-4827-9343-ab5bce62357e" />
+
+   </details>
+
+   <details>
+   <summary>🤷 Having trouble?</summary><br/>
+
+   If the **Run and Debug** area is empty, try reloading VS Code: Open the command palette (`Ctrl`+`Shift`+`P`) and search for `Developer: Reload Window`.
+
+   <img width="300" alt="empty run and debug panel" src="https://github.com/user-attachments/assets/0dbf1407-3a97-401a-a630-f462697082d6" />
+
+   </details>
+
+1. Use the **Ports** tab to find the webpage address, open it, and verify it is running.
+
+   <details>
+   <summary>📸 Show screenshot</summary><br/>
+
+   <img width="350" alt="ports tab" src="https://github.com/user-attachments/assets/8d24d6b5-202d-4109-8174-2f0d1e4d8d44" />
+
+   ![Screenshot of Mergington High School WebApp](https://github.com/user-attachments/assets/5e1e7c1e-1b0e-4378-a5af-a266763e6544)
+
+   </details>
+
+</details>
+
+## ⌨️ Activity: Add a branch ruleset
+
+To get started, let's add some protections so that no one accidentally breaks the club registration system.
+
+1. If necessary, open another tab and navigate to this repository. We will start on the **Settings** tab.
+
+1. In the left navigation, expand the **Rules** area and select **Rulesets**.
+
+1. Click the **New ruleset** dropdown and select **New branch ruleset**.
+
+   <img width="250" alt="image" src="https://github.com/user-attachments/assets/1e9fd519-1421-4d6b-b654-a3fe53a8fb75" />
+
+1. Set the **Ruleset Name** as `Protect main` and change the **Enforcement status** to `Active`.
+
+   <img width="250" alt="image" src="https://github.com/user-attachments/assets/ce30fd34-39b5-4e22-b348-4af61fd05cd1" />
+
+1. Find the **Targets** section and use the **Add target** dropdown to add 2 entries:
+
+   1. Add the **Include default branch** option to ensure protections aren't bypassed by switching the default branch.
+
+      <img width="250" alt="image" src="https://github.com/user-attachments/assets/217263cc-d5c2-4ac0-b03c-a72494e5c812" />
+
+   1. Use the **include by pattern** option and enter the pattern `main`.
+
+      <img width="250" alt="image" src="https://github.com/user-attachments/assets/968c9ed8-b051-44eb-af42-d99670ad31fd" />
+
+      <img width="250" alt="image" src="https://github.com/user-attachments/assets/ddc52767-d93e-4c9e-a77a-90c3b5c08fb5" />
+
+1. Find the **Rules** section and ensure the following items are checked.
+
+   - [x] Restrict deletions
+   - [x] Require a pull request before merging
+     - Required approvals: `0`
+     - [x] Require review from Code Owners
+   - [x] Block force pushes
+
+1. Scroll to the bottom and click the **Create** button to save the ruleset.
+
+## ⌨️ Activity: Create a `.gitignore` file
+
+We know many teachers use different tools, so let's make sure they don't accidentally commit unnecessary files.
+
+1. At the top navigation, return to the **Code** tab and verify you are on the `main` branch.
+
+1. Above the list of files, click the **Add file** dropdown and select **Create new file**.
+
+   <img width="300" alt="New file button" src="https://github.com/user-attachments/assets/8f3f8da8-1471-485a-9df5-8c03ecba2d8e"/>
+
+1. Enter the file name `.gitignore`. We will ignore the template selector for now and make our own. Copy the below example content into it.
+
+   <img width="350" alt="preview of new file" src="https://github.com/user-attachments/assets/580d1a63-a264-4d44-8901-50ad708b8822"/>
+
+   ```gitignore
+   # Python backend for club management
+   __pycache__/
+   *.py[cod]      # Python compiled files
+   *$py.class
+   *.so
+   .Python
+   env/
+   .env           # Where database passwords are stored
+   venv/          # Virtual environment for testing
+   .venv
+
+   # Teacher IDE settings
+   .vscode/       # Ms. Rodriguez uses VS Code
+   .idea/         # Mr. Chen uses PyCharm
+
+   # Local development & testing
+   instance/
+   .pytest_cache/
+   .coverage      # Test coverage reports
+   htmlcov/
+
+   # Staff computer files
+   .DS_Store      # For teachers with Macs
+   Thumbs.db      # For teachers with Windows
+   ```
+
+1. In the top right, select the **Commit changes...** button. Notice that it won't let us commit to the `main` branch! Our ruleset is working! Nice!
+
+   <img width="400" alt="image" src="https://github.com/user-attachments/assets/4e85948d-75c8-4c13-8ddd-4707bf9b0805" />
+
+1. Enter `prepare-to-collaborate` for the branch name then click the **Propose changes** button. You will be forwarded to a new page to start a new pull request.
+
+1. Set the title to `Prepare to collaborate` and click the **Create pull request** button. **Do NOT merge yet**, since we will be adding more collaboration related changes.
+
+1. With the file committed, wait a moment for Mona to check your work, provide feedback, and share the next lesson.
+
+> [!TIP]
+> GitHub and the community have built a repository with [sample `.gitignore` files](https://github.com/github/gitignore) for many situations. Make sure to check it out!
+
+<details>
+<summary>🤷 Having trouble?</summary><br/>
+
+Make sure you pushed the `.gitignore` file to `prepare-to-collaborate` branch. Exact naming for both matters!
+
+</details>

.github/steps/2-prepare-to-collaborate.md

@@ -0,0 +1,134 @@
+# Step 2: Prepare to collaborate
+
+Your simple school website has become quite popular! After showing it at the last staff meeting, Ms. Rodriguez from the Art Club and Mr. Chen from the Chess Club came up to you super excited. They have tons of ideas for new features!
+
+- Ms. Rodriguez wants to add a photo gallery
+- Mr. Chen dreams of adding a tournament bracket system for the chess/sports activities! 🎨♟️
+
+While you're thrilled about their enthusiasm, you realize you need to set up some guidelines before letting them start changing code. The last thing you want is conflicting changes breaking the registration system right before spring break!
+
+Opening your project to other teachers at Mergington High means thinking about how everyone will collaborate together without breaking each other's code.
+
+**Collaborators** are the people you have granted write access to the project through repository settings.
+
+- Provide other people permissions to change project files while still protecting repository settings.
+- Personal repositories have simple permissions. Organization repositories allow flexible permissions such as read, write, maintain, and admin.
+
+To help with collaboration, GitHub provides two special files:
+
+1. **`CONTRIBUTING.md` file** - A "How to Help" guide. Some example content:
+
+   - How to prepare a developer setup of the extra-curricular activities website.
+   - The process for suggesting changes.
+   - The project's coding style preference, to keep things consistent.
+   - How to ask for help when stuck.
+
+1. **`CODEOWNERS` file** - Assign specific people or teams responsible for a portion of the project.
+
+   - When someone creates a pull request, GitHub will automatically ask the right person to review it.
+
+## ⌨️ Activity: Create a welcoming contribution guide
+
+The IT Club meeting is tomorrow, and you need to prepare for Ms. Rodriguez and Mr. Chen to join the project. Let's start a document to help them contribute effectively.
+
+1. At the top navigation, return to the **Code** tab. Ensure you are on the `prepare-to-collaborate` branch.
+
+   <img width="350" alt="image showing the correct branch" src="https://github.com/user-attachments/assets/68cd1e7a-1b34-47eb-9f0b-095d47442b12" />
+
+1. In the top directory, create a new file called `CONTRIBUTING.md` (case sensitive).
+
+1. Add a welcoming message.
+
+   ```md
+   # Contributing to the Mergington High Extra-Curricular Activities Website
+
+   Thank you for your interest in helping improve our school's website!
+   Whether you want to add your club's activities, fix a bug, or suggest
+   new features, this guide will help you get started. 🎉
+   ```
+
+1. Add instructions to help teachers quickly start developing.
+
+   ```md
+   ## Development Setup
+
+   1. Clone the repository to your computer.
+   2. Install Python requirements: `pip install -r requirements.txt`.
+   3. Run the development server: `python src/app.py`.
+   4. Visit http://localhost:8000 in your browser to see the website.
+
+   ## Making Changes
+
+   1. Create a new branch for your changes.
+      - Use descriptive names like `art-gallery-feature` or `fix-chess-signup`
+   2. Make your changes and test them locally with sample student data.
+      - Use the MongoDB extension to preview the included sample date.
+   3. Push your branch and create a pull request.
+   4. Wait for review and address any feedback.
+
+   ## Code Style
+
+   - Follow PEP 8 for Python code (backend).
+   - Use clear, descriptive variable names (student_name, start_time, etc.)
+   - Add comments to describe blocks of logic.
+   ```
+
+1. Add a section for getting help.
+
+   ```md
+   ## Need help or have ideas?
+
+   - Check the open issues first.
+     - If your problem is there, add a comment or up-vote.
+     - If not there, create a new issue. Be as descriptive as possible.
+   - Ask in our weekly IT Club office hours (Thursdays at lunch in Room 203).
+   - For other general problems, email the tech team at [email protected]
+   ```
+
+1. In the top right, use the **Commit changes...** button and commit your changes directly to `prepare-to-collaborate` branch.
+
+## ⌨️ Activity: Assign code ownership
+
+With others joining the fun, you want to stay involved on anything affecting architecture and core functionality. Let's assign you to the related files.
+
+1. At the top navigation, return to the **Code** tab. Ensure you are on the `prepare-to-collaborate` branch.
+
+1. In the top directory, create a new file called `CODEOWNERS` (case sensitive and no extension).
+
+1. Add the following content:
+
+   ```codeowners
+   # Core functionality - changes here should be rare!
+   /src/app.py                   @{{ login }}
+   /src/backend/database.py      @{{ login }}
+   /src/backend/routers/auth.py  @{{ login }}
+
+   # The frontend will need refactored soon to be more object oriented.
+   /src/static/   @{{ login }}
+   ```
+
+1. In the top right, use the **Commit changes...** button and commit your changes directly to `prepare-to-collaborate` branch.
+
+1. With the files committed, wait a moment for Mona to check your work, provide feedback, and share the next lesson.
+
+## ⌨️ Activity: (Optional) Add your first collaborator
+
+Ready to let your colleague start working on that photo gallery feature? Let's do it!
+
+> [!IMPORTANT]
+> This step is optional because it requires another person with a GitHub account to participate.
+
+1. In the top navigation, select the **Settings** tab.
+
+1. In the left navigation, select **Collaborators**.
+
+1. Find the **Manage access** area and click the **Add people** button.
+
+   <img width="350" alt="" src="https://github.com/user-attachments/assets/686c32c6-11c2-4e69-bad1-39062d5b4376" />
+
+1. Enter a friend/colleague's GitHub username or email then press the **Add to repository** button.
+
+   <img width="350" alt="" src="https://github.com/user-attachments/assets/d0eaf344-baf0-4a9c-9291-c11e7a9fdaa3" />
+
+> [!IMPORTANT]
+> Personal repositories only have one collaboration role type. A "collaborator" receives **write** permissions but NOT **admin** permissions. If you need finer permissions, consider starting a free [organization](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/about-organizations) and assigning [repository roles](https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization).