Skip to content

Latest commit

 

History

History
95 lines (58 loc) · 3.03 KB

README.md

File metadata and controls

95 lines (58 loc) · 3.03 KB
Raw

Study Buddy

Introduction

StudyBuddy is a web application that aids students in the learning process by automatically generating notes from audio recordings. The purpose is to help students to recall what they learned in class, which ultimately allows them to learn better.

Prerequisites

Before you begin, ensure you have the following installed:

  • Python (version 3.11 or above)
  • pip (Python package manager)

Note you may need to run the following commands with either: python or python3 and pip or pip3

Setting Up the Project

1. Clone the Repository

Clone the project repository to your local machine and navigate to cloned directory using:

git clone https://github.com/arishimam/studybuddy.git
cd studybuddy

2. Create a Virtual Environment

For macOS/Linux:

python -m venv venv
source venv/bin/activate

For Windows:

python -m venv venv
venv\Scripts\activate

3. Install Required Packages

Install all the required packages using:

pip install -r requirements.txt

4. Environment Setup

Creating a .env File

For the project to function correctly, you need to set up environment variables, including your OpenAI API key. Create a .env file in the same directory as the .env.evample file provided in the project. This will likely be located in the directory: studybuddy/studybuddy. Add your OpenAI API key as follows:

OPENAI_API_KEY=your_api_key_here

Replace your_api_key_here with your actual OpenAI API key. This file will be used by the application to securely access the API key without hardcoding it into the source code.

Important: Ensure that the .env file is added to your .gitignore file to prevent your API key from being exposed publicly.

Running the Django Project

Run the Django Server

Start the Django development server by running:

python manage.py runserver

Now, the Django project should be accessible at http://127.0.0.1:8000/studybuddy.

Running Celery

Celery is used for asynchronous task processing. We use it in this project to make the api calls to OpenAI for generating notes from uploaded audio files. To run Celery, open a new terminal and ensure your virtual environment is activated.

For macOS/Linux:

celery -A myproject worker -l info

For Windows:

For Windows, you might need to use different commands based on your specific setup. Generally, you can start the Celery worker using:

celery -A myproject worker -l info

However, if you encounter any issues, please refer to the Celery Documentation for Windows-specific instructions.

Additional Notes

You can either register a new account or test with an existing account. Here are the credentials for user account that already contains some generated notes:

tester
tablet12
  • Note there is currently an issue running the celery worker on some Windows Operating Systems. If celery is unable to communicate with Django, the note generation functionality will not work.