https://github.com/rotimi-best/sveltedoc

Think of Google doc (without the whole collaboration complexity) with a twist that all the documents you create are open to everyone to find and leave comments. Something like youtube but for documents or github gists. Its a PWA
https://github.com/rotimi-best/sveltedoc

google-docs hackathon pwa supabase supabase-js svelte

Last synced: 3 days ago
JSON representation

Think of Google doc (without the whole collaboration complexity) with a twist that all the documents you create are open to everyone to find and leave comments. Something like youtube but for documents or github gists. Its a PWA

• Host: GitHub
• URL: https://github.com/rotimi-best/sveltedoc
• Owner: rotimi-best
• Created: 2021-08-03T22:41:17.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-07-18T15:56:06.000Z (about 2 years ago)
• Last Synced: 2024-09-19T03:38:58.253Z (8 days ago)
• Topics: google-docs, hackathon, pwa, supabase, supabase-js, svelte
• Language: Svelte
• Homepage: https://sveltedoc.xyz
• Size: 365 KB
• Stars: 17
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  

    

    
SvelteDoc


  



## What is SvelteDoc?

Think of Google doc (without the whole collaboration complexity) with a twist that all the documents you create are open to everyone to find and leave comments.

Something like youtube but for documents or github gists. Making it public by default sounds wierd however I believe open source and collaboration is becoming the acceptable norm.



  



## Why does it matter?

I studied computer science in russian language and as a foreign student it was diffcult for me to keep up with the lecturer while he/she dictates during a lecture. In order to stay up to date I would ask for the notebook of a course mate or take a picture of everything written by that student, then when I got home, I would have to copy everything into my notebook. 



  



This was so time consuming and I don't want anyone to have to go through this. My idea was what if every note taken by all students in the lesson is made public to everyone? I have been thinking about this project for a long time now and I felt now is the best time to build the MVP.

## Demo

https://user-images.githubusercontent.com/31730715/128574952-44da5ad0-4c14-4c26-b0ed-ec0cb03af92e.mp4

You can also visit [https://sveltedoc.xyz](https://sveltedoc.xyz) to try it out for your self

## TechStack

- UI - Svelte w/ SvelteKit

- Backend (and every other good thing) - Supabase.



  



## Features implemented

- Magic link authentication (Auth)

- Search for documents - only by title (Data)

- View in realtime comments increment count on documents list page (Realtime)

- CRUD your documents -(Data)

- View other documents + leave comments and view other comments in real time (Realtime)

- View documents and edit your username + a default avatar (hosted on supbase storage)

## Run Locally

To run it locally you will need to setup a supbase project with all my settings and configurations which can be tricky - if need be I can give the judges access to the project. However the `.env` file requires 2 variables



  



```

VITE_SUPABASE_URL=

VITE_SUPABASE_ANON_KEY=

```

## In conclusion