Project structure

MatthewAndreTaylor · Feb 1, 2024 · bc912da · bc912da
1 parent 6994f5a
commit bc912da
Show file tree

Hide file tree

Showing 18 changed files with 101 additions and 0 deletions.
diff --git a/.github/workflows/branch_naming.yml b/.github/workflows/branch_naming.yml
@@ -0,0 +1,13 @@
+name: 'Assert Branch Naming Convention'
+on: pull_request
+
+jobs:
+  branch-naming-rules:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: deepakputhraya/action-branch-name@master
+        with:
+          regex: '^.*-u\d+$'
+          ignore: master,development
+          min_length: 5
+          max_length: 20
diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
@@ -0,0 +1,13 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v3
+    - uses: pre-commit/action@v3.0.1
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,18 @@
+__pyc*
+build
+dist
+.idea
+.vscode
+.tox
+.pytest_cache
+__pycache__/*
+*.so
+*.pyd
+*.egg-info
+*.whl
+.venv
+venv
+instance
+.DS_Store
+__pycache__
+*.pyc
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,21 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+    -   id: requirements-txt-fixer
+-   repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+    -   id: black
+-   repo: https://github.com/hhatto/autopep8
+    rev: v2.0.4
+    hooks:
+    -   id: autopep8
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+    -   id: mypy
+        additional_dependencies: [types-all]
diff --git a/README.md b/README.md
@@ -0,0 +1,2 @@
+# Snowfall-Saga
+CSC301 Project
diff --git a/app/app.py b/app/app.py
@@ -0,0 +1,3 @@
+from flask import Flask
+
+app = Flask(__name__)
diff --git a/app/auth/static/login.css b/app/auth/static/login.css
diff --git a/app/auth/templates/auth/login.html b/app/auth/templates/auth/login.html
diff --git a/app/config.py b/app/config.py
diff --git a/app/lobby/__init__.py b/app/lobby/__init__.py
diff --git a/app/lobby/lobby.py b/app/lobby/lobby.py
@@ -0,0 +1,14 @@
+from flask import Blueprint
+
+lobby = Blueprint(
+    "lobby",
+    __name__,
+    template_folder="templates",
+    static_folder="static",
+    static_url_path="assets",
+)
+
+
+@lobby.route("/")
+def home():
+    return "Hello World"
diff --git a/app/lobby/static/main.js b/app/lobby/static/main.js
diff --git a/app/lobby/templates/lobby/index.html b/app/lobby/templates/lobby/index.html
diff --git a/app/models.py b/app/models.py
diff --git a/app/static/style.css b/app/static/style.css
diff --git a/app/trivia/trivia.py b/app/trivia/trivia.py
diff --git a/pull-request-template.md b/pull-request-template.md
@@ -0,0 +1,16 @@
+# User Story Name (User Story #)
+
+User Story Goals:
+- [ ] my code achieves the goal
+- [ ] my code is working on multiple machines
+- [ ] what architecture costs does implementing this story entail
+
+Changes:
+- [ ] Explain the changes made at a higher level
+- [ ] Have dependencies/packages been added?
+
+Checklist:
+- [ ] my code follows the style guidelines
+- [ ] my changes did not produce and new errors or warnings
+- [ ] updated/added documentation and comments to reflect my changes
+- [ ] I have added/updated tests for my changes
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1 @@
+Flask==2.2.2