LecSum

PDF Lecture Summarizer

Summarization tool for lecture materials using NLP
Explore the docs »

Table of Contents

1. About The Project
   • Built With
2. Getting Started on Back-End
3. Getting Started on FrontEnd

About The Project

*Project details here

Built With

Getting started on Backend

Quick guide on how to get the backend started up and running

Installation

1. Make sure you are in backend folder and start virtual environment

   cd backend  #change directory

2. Create a new conda environment with required packages:

conda env create -f environment.yaml
# This creates a new environment named lecsum
# Activate this environment
conda activate lecsum

3. Download tokenizer and tagger from nltk_data directory

python -c "import nltk; nltk.download('punkt'); nltk.download('averaged_perceptron_tagger')"

4. Finally Start the backend

   # Running server in: http://localhost:3001
   python manage.py runserver 3001

5. If you get " module not found" error, then try doing the below

   pip install <some> # put in the modeule name in <some> GL

Getting started on FrontEnd

Quick guide on how to get the FrontEnd started up and running

1. Make sure you are in frontend folder

   cd frontend

2. Install NPM in terminal

   npm install

3. Start NPM in terminal

   npm start

(back to top)