Skip to content

cyber-tutor/backend

Repository files navigation

Cyber Tutor Backend

Contributors: Andrew Krasuski, Matthew Quijano, Sean Clifford, Roland Van Duine

Cyber Tutor is a proof-of-concept learning web-application with the goal of raising cybersecurity awareness among the general populous, leveraging artificial intelligence (Google Gemini) to provide a personalized learning experience.

cyber tutor linkedin post

Artificial Intelliegence Content Generation Pipeline

We utilize LangChain to enhance the quality of AI content by sourcing the LLM's knowledge off of sources vetted by our team and professor.

cyber tutor langchain flow

Local Instance Instructions

Since our project uses Django 5.0, Python 3.10 or later is required for installation.

In Visual Studio Code:

  1. Clone the GitHub repository
  2. Create, and activate, a virutal environment

    Linux

        sudo apt-get install python3-venv
        python3 -m venv .venv
        source .venv/bin/activate

    macOS

        python3 -m venv .venv
        source .venv/bin/activate

    Windows

        py -3 -m venv .venv
        .venv\scripts\activate
  3. Select interpreter:
  • CTRL + SHIFT + P
  • Select: Python: Select Interpreter
  • Select: Interpreter path that starts with ./.venv or .\.venv
  1. Install project dependencies:
 pip install -r requirements.txt
  1. Set up .env file
  • Create .env file in root, where manage.py is located
  • SECRET_KEY = 'STEP 6'
    GEMINI_API_KEY = ''
    POSTGRES_PASSWORD = ''
    AWS_ENDPOINT_URL = ''
  1. Generate your SECRET_KEY
  • CTRL + SHIFT + `
  • python
  • from django.core.management.utils import get_random_secret_key
    print(get_random_secret_key())
  • Copy, and paste that into your .env, where you see 'STEP 6'
  1. Apply migrations to the database
python manage.py migrate
  1. Run the development server:
python manage.py runserver

About

DOI for Published Research: http://doi.org/10.1007/978-3-031-94159-7_1

Resources

Stars

Watchers

Forks

Contributors 5

Languages