Skip to content

Study note generating web application via YouTube transcript api and GPT 3.5

Notifications You must be signed in to change notification settings

lasanseniya/nova-web-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NOVA - YouTube study notes generator

Description:

Nova web application utilises youtube transcriptions and gpt 3.5 turbo to generate study notes corresponding to the user specified YouTube video.

Study notes follow a cornell structure comprising of,

  1. Structured note
  2. Cue questions (to improve recall to information)
  3. Summary

Purpose:

Generating study notes for solo and self learners from thier favourite YouTube sources.


Dependencies

Frontend

runtime developement
axios tailwind
html-react-parser prettier
react-dom cypress
react-router-dom eslint
react-hot-toast vite
react-icons
react-spinners

Backend

runtime developement
bcrypt nodemon
cors
dotenv
express
express-async-handler
jsonwebtoken
mongoose
node-fetch
nodemailer
youtube-transcript

Pre-requisites and installation

  • MongoDB Atlas connection string

  • GPT 3.5 turbo API key

  • NodeJS 16.x or above

  • Google app password for enabling email


  1. clone the repo to your local development environment
    git clone https://github.com/lasanseniya/nova-web-app.git

  2. Install the packages in both frontend and backend via,
    npm install

  3. create .env files containing the following info,

    Frontend:

    VITE_API_KEY - gpt 3.5 turbo api key
    VITE_SERVER_URL - server url
    

    Backend:

    PORT - port number
    CONNECTION_STRING - mongoDB atlas connection string
    ACCESS_TOKEN_SECRET - an access token secret
    FRONTEND_URL - frontend url
    EMAIL_FROM - email address
    EMAIL_PASSWORD - google app password from above email
    
  4. start the dev backend server and frontend via,
    npm run dev


Tech Stack

My Skills


Screenshots

User Login and SignUp

Login page SignUp page

OTP send & verification

password change password change

Password reset

Study note generation

Note storage


Contributors

@lasanseniya

@savindisilva

@ranidhiperera

@chamathmunasinghe

@kusalpathirage

Releases

No releases published

Packages

No packages published

Languages