Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shxntanu/pagetalk
💬 Document Reading, Redefined. Converse with any document!
https://github.com/shxntanu/pagetalk
flask llm mixtral-8x7b nextjs portfolio
Last synced: 15 days ago
JSON representation
💬 Document Reading, Redefined. Converse with any document!
- Host: GitHub
- URL: https://github.com/shxntanu/pagetalk
- Owner: shxntanu
- License: mit
- Created: 2024-04-04T19:02:59.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-04-05T05:33:39.000Z (9 months ago)
- Last Synced: 2024-04-05T20:26:43.824Z (9 months ago)
- Topics: flask, llm, mixtral-8x7b, nextjs, portfolio
- Language: TypeScript
- Homepage:
- Size: 489 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PageTalk
### Document Reading, Redefined.
PageTalk allows you to effortlessly converse with your documents. Simply upload a document, and PageTalk will automatically generate a summary of the document. You can then ask questions about the document, and PageTalk will provide you with the answers. PageTalk is perfect for students, researchers, and professionals who want to quickly understand and analyze documents.
Export the document to [NoteSync](https://github.com/techymt/NoteSync), and you can easily share the document with your friends and colleagues. NoteSync allows you to collaborate with others in real-time, making it easy to work together on projects.
# Demo
[Demo.webm](https://github.com/shxntanu/PageTalk/assets/97496261/cbb7bdd1-15d2-41e4-bc76-455a77f436ca)
## Built With
- Frontend: **NextJS**
- Database, Cloud Storage, and Authentication: **Supabase**
- Backend: **Flask**
- LLM: **Mixtral 8x7b**
# Getting Started
1. Set-up a supabase project and get the Public URL and ANON Key.
2. Clone the repository.
3. Create a `.env.local` file in the root directory and add the following environment variables:
```bash
NEXT_PUBLIC_SUPABASE_URL=
NEXT_PUBLIC_SUPABASE_ANON_KEY=
```
4. Create tables in your Supabase database according to the schema in [`client/src/supabase/database.types.ts`](client/src/supabase/database.types.ts).
5. Set up Row Level Policies for each table to allow SELECT, INSERT, DELETE and UPDATE for authenticated users only.
6. Set up authentication in Supabase and enable email verification.
7. Run the following commands:
```bash
cd frontend
npm install
npm run dev
```
That will get your frontend running.
8. For the backend, run the following commands:
```bash
cd backend
python3 -m venv env
source env/bin/activate
pip install -r requirements.txt
python3 server.py
```
That will get your backend running.
9. You will need to add environment variables as specified in [`server/.env.example`](server/.env.example) to a `.env` file in the `server` directory.
10. And that's it! You're all set up.
# Features
- **Document Summarization**: PageTalk automatically generates a summary of the document.
- **Question Answering**: Ask questions about the document, and PageTalk will provide you with the answers.
- **Export to NoteSync**: Export the document to as a Note in proper markdown format to [NoteSync](https://github.com/techymt/NoteSync)
## Contributors
- [Shantanu Wable](https://github.com/shxntanu)
- [Mustafa Trunkwala](https://github.com/techymt)
- [Tejas Thorat](https://github.com/tejaspthorat)