Skip to content

AI dictionary of custom styles and words. Fall 2024. Final Project for CSCI 230 Data Structures and Algorithms Final Project

Notifications You must be signed in to change notification settings

AndrewPBerg/Dope_Dictionary

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Installation

Python Dependencies

This project uses pythons built-in venv to manage dependencies. Once the venv is activated, one can also just use pip install -r requirements.txt.

Python Built-in venv

Make sure to be in the django_project directory when running venv commands

cd django_project

MacOS/Linux

python3 -m venv myenv
source myenv/bin/activate
pip install -r requirements.txt

Windows

python -m venv myenv
.\myenv\Scripts\activate
pip install -r requirements.txt

GoogleGemini API

  1. Set up a Google Gemini API account and generate an API key.
  2. create a .env file in the django_project/project_230/dictionary directory
  3. Set the GOOGLE_API_KEY environment variable to their API key.

note the GOOGLE_API_KEY must be in the .env file to use the app. and the API key should also be in "string" format.

Example .env file:

# .env
GOOGLE_API_KEY="your_api_key_here"

Maven Dependencies

  • used for the Java microservice

Make sure to be in the HashTableService directory when running maven commands Make sure maven is installed

mvn --version

if not installed, install maven from here

Start Maven Service

cd HashTableService
mvn clean compile

NOTE: make sure that the current java version is supported by the maven pom.xml file in the

<properties>
    <java.version>example_version</java.version>
</properties>

To check the current java version, run

java -version

Start the maven service

mvn spring-boot:run

Quick Start

Quick Commands

Activate the python venv

cd django_project
.\myenv\Scripts\activate

Start the django server

cd project_230
python manage.py runserver

In a different Terminal, Start the maven service

cd HashTableService
mvn spring-boot:run

About

AI dictionary of custom styles and words. Fall 2024. Final Project for CSCI 230 Data Structures and Algorithms Final Project

Topics

Resources

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •