README.md

YouTubeSummarizer Backend

Setup

Set up conda env (we need to use a little python to get youtube transcripts)

1. First install conda or miniconda if you haven't already \
2. Create the conda environment:
   conda create --name YoutubeSummarizer
3. Install needed packages (there's only one as of now):
   conda install -c conda-forge youtube-transcript-api
4. The conda environment is now set up!
5. Now we install node.js dependencies:
   npm install (make sure you're in backend directory)
6. Set up needed environment variables:
   You will need to create a file called .env in the backend directory that will hold needed environment variables, the file should look like the following block of code

   PORT=4000
   JWT_SECRET=(ask one of us to send it to you)
   ENCRYPTION_SECRET=(ask one of us to send it to you)
   MONG_URI=(this is the url used to connect to the MongoDB atlas database,
             you will need one of us to set up an account for you
             and to provide you with an access link)
   

Running

1. conda activate YoutubeSummarizer
2. npm start

Endpoint Documentation

Endpoints Requiring Authentication

• TODO explain JWTs and how they are used in this application to handle logging in & out
• all routes aside from the login and register routes require authentication

Authentication Endpoints

• TODO

Summary Endpoints

• Fetch all summaries from user
  • GET localhost:PORT/api/summaries/fetchSummaries
• TODO for the routes that need a body, put a code block with an example of it