EngiDocs

---

📝 Table of Contents

• About
• Demo / Working
• Features
• How it works
• Installation
• Deploying the site
• Built Using
• Authors
• Acknowledgments

About

A sleek modern website offerring comprehensive resources and a powerful summarizer tool to help students efficiently study and excel in their exams.

🎥 Demo / Working

WhatsApp.Video.2024-07-14.at.18.46.36.mp4

✨✨ Features

• Notes
• Videos
• PYQs
• Summariser (TL;DR)

💭 How it works

EngiDocs lets you get the required notes, videos and pyqs based on the year , stream and subject you choose. Then it extracts the given pdfs from the site and redirects you into TL;DR , a summariser tool. It then fetches you answers based on your query to promote smart learning.

If the given question is not related to the pdf uploaded in the summariser, it gives an error message and asks you to chat with it related to the pdf uploaded.

🏁 Installation

• 1.Fork and ⭐ the repository

• 2.Clone the repository using git clone https://github.com/GhoshAditi/EngiDocs.git

• 3.Install the dependencies using npm i.

• 4.Fill the env as shown :

//clerk
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=
NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/
NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/

• 5.Run the project using npm run dev.

🚀 Deployment

The site is deployed in Vercel .

• Vercel Link: https://engidocs.vercel.app/

⛏️ Built Using

• NextJs 14
• Typescript
• Tailwind Css
• Clerk

✍️ Authors

• @GhoshAditi - project admin
• @rishicds - Idea and TL;DR implementation

See also the list of contributors who participated in this project.

🎉 Acknowledgements

• Hat tip to anyone whose code was used
• As well thank you to all who have used our website.