Feature/forgot password

.github/workflows/deploy.sh

@@ -0,0 +1,84 @@
+#!/bin/bash
+
+# Constants
+REPO_URL="https://github.com/judithkwesi/ip-monitoring-tool.git"
+PROJECT_DIR="/home/charles/ip-reputation/staging/ip-monitoring-tool"
+VENV_DIR="/home/charles/ip-reputation/staging/dev_env"
+# SYSTEMD_SERVICE="your_service_name.service"
+
+# Function to update the code from GitHub
+update_code() {
+    echo "Updating code from GitHub..."
+    git pull origin staging
+}
+
+# Function to install Python dependencies
+install_dependencies() {
+    echo "Installing Python dependencies..."
+    cd "$PROJECT_DIR"
+    echo "Activating Virtual Environment..."
+    source $VENV_DIR/bin/activate
+    pip install -r requirements.txt
+}
+
+# Function to run database migrations
+run_migrations() {
+    echo "Running database migrations..."
+    cd "$PROJECT_DIR"
+    source $VENV_DIR/bin/activate
+    echo "Activating Virtual Environment..."
+    python manage.py migrate
+}
+
+run_collectstatic() {
+    echo "Running static files..."
+    cd "$PROJECT_DIR"
+    source $VENV_DIR/bin/activate
+    echo "Activating Virtual Environment..."
+    chmod +w "$PROJECT_DIR"/static
+
+
+    python manage.py collectstatic --noinput
+}
+
+# Function to restart the server
+# restart_server() {
+#     echo "Restarting the server..."
+#     sudo systemctl restart $SYSTEMD_SERVICE
+# }
+
+# Function to stop the program running on port 8001
+stop_program_on_port() {
+    echo "Stopping program on port 8001..."
+    local pids=$(sudo lsof -t -i :8001)
+
+    if [ -z "$pids" ]; then
+        echo "No program found running on port 8001."
+    else
+        for pid in $pids; do
+            sudo kill -9 "$pid"
+            echo "Terminated process with PID: $pid"
+        done
+        echo "Program(s) stopped successfully."
+    fi
+
+    # restart gunicorn
+    # gunicorn ip-monitoring-tool.wsgi:application --bind 127.0.0.1:8001 &
+    nohup gunicorn ip-monitoring-tool.wsgi:application --bind 127.0.0.1:8001 >/dev/null 2>&1 &
+    disown
+
+    echo "Gunicorn restarted on port 8001."
+}
+
+# Main deployment process
+main() {
+    update_code
+    # install_dependencies
+    run_migrations
+    # restart_server
+    run_collectstatic
+    stop_program_on_port
+    echo "Deployment successful!"
+}
+
+main

.github/workflows/test.sh

@@ -0,0 +1,5 @@
+#!bin/bash
+
+echo "From the bottom, now we are here 1"
+echo "From the bottom, now we are here 2"
+echo "From the bottom, now we are here 3"

.gitignore

@@ -15,5 +15,10 @@ secret_key.txt
 ip-monitoring-tool/__pycache__/
 **/migrations/
 
+.coverage
+htmlcov/
+
+mainapp/tests
+
 #Except
 !mainapp/static

CONTRIBUTING.md

@@ -0,0 +1,60 @@
+# CONTRIBUTING GUIDELINES
+
+### Branch Naming
+
+To have a consitent and well-defined branch naming convention for effective collaboration and verson control management, please following the following guidelines
+
+#### 1. Branch Prefixes:
+
+Consider using specific prefixes to indicate the purpose of the branch. For example:
+
+- `feature/` for new feature development
+- `bugfix/` for bug fixes
+- `hotfix/` for critical bug fixes
+- `release/` for release preparation
+- `docs/` for documentation updates
+- `chore/` for maintenance or other non-feature tasks
+
+For example, if you are working on a new feature for addind users, you might create a branch with the name `feature/add-user`. If it's a bugfix, you might use `bugfix/fix-validation-bug`.
+
+#### 2. Use Hyphens
+
+Use hyphens to separate words in the branch name for better readability. For example, `feature/add-user` or `bugfix/fix-validation-bug`.
+
+#### 3. Short and Meaningful
+
+Keep branch names concise but meaningful. Avoid excessively long names that may become cumbersome.
+
+#### 4. Lowercase Letters
+
+Use lowercase letters for branch names to maintain consistency and avoid potential issues with case sensitivity on different operating systems.
+
+#### 5. Avoid Special Characters
+
+Avoid using special characters or spaces in branch names to ensure compatibility across various version control systems.
+
+#### 6. Use Descriptive Names
+
+Choose branch names that clearly describe the purpose or the feature being worked on. Avoid generic names like "branch1" or "fix_bug".
+
+### Use Meaningful commit messages
+
+#### 1. Be Descriptive
+
+Start the commit message with a concise description of what the commit accomplishes. Use the imperative mood (`Add`, `Fix`, `Update`, `Refactor`, `Revert`, `test`, `chore`) to indicate the action performed.
+
+#### 2. Reference Issues
+
+If the commit relates to an issue or task, include a reference to it using issue numbers (e.g., "Fixes #123," "Closes #456,").
+
+#### 3. Be Consistent:
+
+Use the same commit style throughout to keep consistency
+forexample
+```shell
+ docs: correct spelling of CHANGELOG
+```
+
+Reference
+
+[Converntional Commites](https://www.conventionalcommits.org/en/v1.0.0/)

README.md

@@ -3,26 +3,26 @@
 The IP Reputation Monitoring Application is a web-based tool that enables the organization to assess the reputation of IP addresses and blocks in real-time.
 
 # Features
+
 - [x] Authentication
 - [x] User Interface Design
 - [x] Dashboard
 - [x] User management
-- [] Responsive Design
-- [] Settings
-- [] Download Sites files
-- [] Checking for ips in the sites
-- [] Documents
-
-
+- [ ] Responsive Design
+- [ ] Settings
+- [ ] Download Sites files
+- [ ] Checking for ips in the sites
+- [ ] Documents
 
 #### Team 1
 
-David Ssenabulya
-
-Charles Kasasira
-
-Nantale Tracy Cynthia
-
-Kizza Judith Kwesiga
+| #   | Names                 |
+| --- | --------------------- |
+| 1   | David Ssenabulya      |
+| 2   | Charles Kasasira      |
+| 3   | Nantale Tracy Cynthia |
+| 4   | Kizza Judith Kwesiga  |
+| 5   | Tugume Jullian Praise |
 
-Tugume Jullian Praise
+*For the Developers,
+Follow the [CONTRIBUTING](./CONTRIBUTING.md) guidelines

ip-monitoring-tool/settings.py

@@ -1,32 +1,29 @@
 from pathlib import Path
 import os
+import sys
 
-# Build paths inside the project like this: BASE_DIR / 'subdir'.
-BASE_DIR = Path(__file__).resolve().parent.parent
 
-# SECURITY WARNING: keep the secret key used in production secret!
-# with open(os.path.join(BASE_DIR, 'secret_key.txt')) as f:
-# 	SECRET_KEY = f.read().strip()
+BASE_DIR = Path(__file__).resolve().parent.parent
 
 if os.environ.get("GITHUB_ACTIONS") == "true":
-    # Running in GitHub Actions, get the secret key from the environment variable
     SECRET_KEY = '459a2211e3e1cb2219fde2460560070c7081872b629211708'
 else:
-    # Not running in GitHub Actions, read the secret key from the file
     with open(os.path.join(BASE_DIR, 'secret_key.txt')) as f:
         SECRET_KEY = f.read().strip()
 
-# SECURITY WARNING: don't run with debug turned on in production!
-DEBUG = False
+DEBUG = True
 
-ALLOWED_HOSTS = ['137.63.148.213', '127.0.0.1']
+ALLOWED_HOSTS = ['137.63.148.213', '127.0.0.1', 'crappie-first-koala.ngrok-free.app']
+
+if 'test' in sys.argv or 'test_coverage' in sys.argv:
+    COVERAGE_MODULE_EXCLUDES = ['tests', 'mainapp/migrations', 'migrations', 'settings']
+    COVERAGE_REPORT_HTML_OUTPUT_DIR = 'coverage_html'
 
 # Application definition
 
 INSTALLED_APPS = [
-    'mainapp',  # First priority application: We shall use this application's
-                #templates instead of the inbuilt templates
-    'django.contrib.admin', #This app is to be used for authentication
+    'mainapp',
+    'django.contrib.admin',
     'django.contrib.auth',
     'django.contrib.contenttypes',
     'django.contrib.sessions',
@@ -49,7 +46,7 @@
 TEMPLATES = [
     {
         'BACKEND': 'django.template.backends.django.DjangoTemplates',
-        'DIRS': [],
+        'DIRS': [os.path.join(BASE_DIR, 'templates')],
         'APP_DIRS': True,
         'OPTIONS': {
             'context_processors': [
@@ -66,7 +63,6 @@
 
 
 # Database
-
 DATABASES = {
     'default': {
         'ENGINE': 'django.db.backends.sqlite3',
@@ -92,35 +88,85 @@
 ]
 
 
-# Internationalization
+LOGGING = {
+    'version': 1,
+    'disable_existing_loggers': False,
+    'formatters': {
+        'verbose': {
+            'format': '[%(asctime)s] %(message)s',
+            'datefmt': '%d/%b/%Y %H:%M:%S',
+        },
+    },
+    'handlers': {
+        'file': {
+            'level': 'DEBUG',
+            'class': 'logging.FileHandler',
+            'filename': './ip-monitoring-logs.log',
+            'formatter': 'verbose',
+        },
+    },
+    'loggers': {
+        'ip-monitoring-tool': {
+            'handlers': ['file'],
+            'level': 'DEBUG',
+            'propagate': True,
+        },
+    },
+}
 
-LANGUAGE_CODE = 'en-us'
 
-TIME_ZONE = 'UTC'
 
+# Internationalization
+LANGUAGE_CODE = 'en-us'
+TIME_ZONE = 'UTC'
 USE_I18N = True
-
 USE_L10N = True
-
 USE_TZ = True
 
 
 # Static files (CSS, JavaScript, Images)
-
 STATIC_URL = 'static/'
 STATIC_ROOT = 'static/'
 
 
 # Default primary key field type
-
 DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
 
 LOGIN_REDIRECT_URL = 'dashboard'
 LOGIN_URL = 'login'
 LOGOUT_URL = 'logout'
 
 # Session
+SESSION_EXPIRE_AT_BROWSER_CLOSE = True
 SESSION_COOKIE_AGE = 3600  # 1 hour
 
 # Secure flag for the session cookie (set it to True for HTTPS-only)
 SESSION_COOKIE_SECURE = False
+
+
+# CSRF_TRUSTED_ORIGINS = ['https://crappie-first-koala.ngrok-free.app', 'http://137.63.148.213:8888']
+CSRF_TRUSTED_ORIGINS = ['http://137.63.148.213:8888']
+
+
+
+
+# settings.py
+
+# Set the email backend for sending emails through SMTP
+# EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
+
+# Set the email backend for sending emails through console
+EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
+
+# SMTP settings
+# EMAIL_HOST = 'smtp.gmail.com'  # Replace with your SMTP server address
+# EMAIL_PORT = 587  # Replace with your SMTP server port (587 for TLS, 465 for SSL)
+# EMAIL_USE_TLS = True  # Use TLS (True) or SSL (False) depending on your server configuration
+# EMAIL_USE_SSL = False
+# EMAIL_HOST_USER = 'daveseynabou@gmail.com'  # Replace with your email address
+# EMAIL_HOST_PASSWORD = 'your_email_password'  # Replace with your email password or API key
+# DEFAULT_FROM_EMAIL = 'admin@renu.ac.ug'  # Replace with the email address to appear as the sender
+
+CSRF_TRUSTED_ORIGINS = ['https://crappie-first-koala.ngrok-free.app', 'http://137.63.148.213:8888']
+# CSRF_TRUSTED_ORIGINS = ['http://137.63.148.213:8888']
+

mainapp/apps.py

@@ -6,5 +6,5 @@ class MainappConfig(AppConfig):
     name = 'mainapp'
 
     def ready(self):
-        from .scheduler import updater
-        updater()
+        from .scheduler import schedule_site_downloads
+        schedule_site_downloads()