first commit

.gitignore

@@ -0,0 +1,4 @@
+*.sqlite3
+*.pyc
+.env
+.venv

README.md

@@ -0,0 +1,93 @@
+# NECYSC App
+
+## Getting Started.
+
+Django is a Model-View-Template (MVT) framework that allows you to build web applications. It is a high-level Python web framework that encourages rapid development and clean, pragmatic design. This means that developers will be either working on the models, the views, or the templates. The models are the database, the views are the logic and processing, and the templates are the frontend.
+
+1. Read the documentation: [Documentation](https://docs.djangoproject.com/en/5.1/intro/overview/)
+
+2. Ensure Python 3.11+ is installed on your machine. If not, download it from [Python](https://www.python.org/downloads/)
+
+3. Install Django using pip. Run the following command in your terminal. Create a virtual environment if you want to.
+
+```bash
+    pip install -r requirements.txt
+```
+
+4. Run the server.
+
+```bash
+    python manage.py runserver
+```
+
+5. Open your browser and go to `http://localhost:8080/necysc_app`
+
+6. To access the admin panel, go to `http://localhost:8080/admin` and login with the following credentials:
+
+```bash
+    username: admin
+    password: password
+```
+
+7. To create a superuser, run the following command in your terminal.
+
+```bash
+    python manage.py createsuperuser
+```
+
+8. To make migrations (updating the database column headers if you change the models), run the following command in your terminal.
+
+```bash
+    python manage.py makemigrations
+    python manage.py migrate
+```
+
+9. An example codebase for another website I previously worked on: https://github.com/charlestang06/tutoring-app/tree/master
+
+## Tech Stack
+
+- **Frontend**: HTML, CSS (Bootstrap 5.0), JavaScript
+- **Backend**: Django, MySQL
+- **Deployment**: Python 3.11.5, WSGI
+
+## Features
+
+When creating a new feature, create a new view and a new template. Add the view to the `urls.py` file in the `necysc_app` folder.
+
+- Setting up Model for Applicants (features)
+- Setting up the Applicant Registration Form
+- Landing page
+- Registration pages
+- Login page
+- Admin dashboard
+
+## How To Run
+
+We assume you have the latest version of Python installed.
+
+1. Clone the repository
+
+```bash
+    git clone
+```
+
+2. Install the required packages
+
+```bash
+    pip install django
+```
+
+3. Make migrations
+
+```bash
+    python manage.py makemigrations
+    python manage.py migrate
+```
+
+4. Run the server.
+
+```bash
+    python manage.py runserver 8080
+```
+
+5. Open your browser and go to `http://localhost:8080/`

manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "necysc.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()

necysc/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for necysc project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.0/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "necysc.settings")
+
+application = get_asgi_application()

necysc/settings.py

@@ -0,0 +1,125 @@
+"""
+Django settings for necysc project.
+
+Generated by 'django-admin startproject' using Django 5.0.2.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.0/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/5.0/ref/settings/
+"""
+
+from pathlib import Path
+from django.core.management.utils import get_random_secret_key
+import os
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/5.0/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "django-insecure-q1=mqny#(29-%o-nf4u0irrf^=d8fl9o47famoay(!ns1x=)ix"
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = ["*"]
+
+# Application definition
+
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "debug_toolbar",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "debug_toolbar.middleware.DebugToolbarMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+]
+
+ROOT_URLCONF = "necysc.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "necysc.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/5.0/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/5.0/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/5.0/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = 'America/New_York'
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/5.0/howto/static-files/
+
+STATIC_URL = "static/"
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/5.0/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

necysc/urls.py

@@ -0,0 +1,28 @@
+"""
+URL configuration for necysc project.
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/5.0/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+
+from django.contrib import admin
+from django.urls import include, path
+from django.contrib.staticfiles.storage import staticfiles_storage
+from django.views.generic.base import RedirectView
+
+urlpatterns = [
+    path("", include("necysc_app.urls")),
+    path("admin/", admin.site.urls),
+    path("__debug__/", include("debug_toolbar.urls")),
+
+]

necysc/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for necysc project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.0/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "necysc.settings")
+
+application = get_wsgi_application()

necysc_app/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

necysc_app/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class NecyscAppConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "necysc_app"

necysc_app/models.py

@@ -0,0 +1,5 @@
+from django.db import models
+
+# Create your models here.
+class Applicant(models.Model):
+    pass

necysc_app/templates/404.html

@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Page Not Found</title>
+    <style>
+      body {
+        font-family: Arial, sans-serif;
+        text-align: center;
+        padding: 50px;
+      }
+      h1 {
+        font-size: 50px;
+      }
+      p {
+        font-size: 20px;
+      }
+      a {
+        color: #007bff;
+        text-decoration: none;
+      }
+      a:hover {
+        text-decoration: underline;
+      }
+    </style>
+  </head>
+  <body>
+    {% load static %}
+    <h1>404</h1>
+    <p>Oops! The page you are looking for does not exist.</p>
+    <p>
+      <a href="{% url 'necysc_app:index' %}">Go back to the homepage</a>
+    </p>
+  </body>
+</html>

necysc_app/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

necysc_app/urls.py

@@ -0,0 +1,8 @@
+from django.urls import path
+
+from . import views
+
+app_name = "necysc_app"
+urlpatterns = [
+    path("", views.index, name="index"),
+]

necysc_app/views.py

@@ -0,0 +1,6 @@
+from django.shortcuts import render
+from django.http import HttpResponse
+
+# Create your views here.
+def index(request):
+    return HttpResponse("Hello, world. You're at home of necysc_app.")