rushilwiz/spaceout
1
0
Fork 0
mirror of https://github.com/Rushilwiz/spaceout.git synced 2025-04-03 03:30:16 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity
Our Hack TJ 7.5 submission! (by rushil umaretiya, chinmay bhandaru, and sam gwon)
50 Commits 1 Branch 0 Tags 21 MiB
CSS 49.9%
Python 41.3%
SCSS 3.5%
Less 3.4%
HTML 1.5%
Other 0.4%
master
Go to file
Rushil Umaretiya eb462c8ad6
updated readme with post-hackathon info
2020-12-21 01:19:05 -05:00
.github shrunk pic 2020-12-13 16:13:10 -05:00
app updated api endpoint 2020-12-13 15:06:06 -05:00
site Final Commit 2020-12-13 15:41:38 -05:00
.gitignore added gitignore to root 2020-12-12 22:09:58 -05:00
app.zip Final Commit 2020-12-13 15:41:38 -05:00
README.md updated readme with post-hackathon info 2020-12-21 01:19:05 -05:00
spaceout.png Final Commit 2020-12-13 15:41:38 -05:00

README.md

Logo

DON'T SpaceOut

GitHub language GitHub language count GitHub code size in bytes GitHub repo size GitHub GitHub last commit

UPDATE: We won a prize! Check out the Devpost here

(and feel free to drop a ❤️, 😄)

huge thanks to the Hack TJ team for an amazing hackathon!

Demo: https://youtu.be/-HXf5dK-OMU

Inspiration

As 2020 comes toward the end, people around the world have endured various struggles because of the coronavirus. Students around the world have been struggling to put full focus on academics during class and taking notes due to the online learning environment.

What it does

SpaceOut uses speech to text features in python for your classes. The first function of SpaceOut is to record your class lectures using a streamed input device and write them down. The second feature of Space out is to notify a user when their name is called in class. Sometimes, students tend to space out, hence the name, during their classes because the online learning environment may not be as engaging as in-person learning. SpaceOut will notify a student anytime their name is called, and show the previous 50 words to the student in order for them to grasp an idea of what they are learning.

How we built it

There were two parts to building SpaceOut. We built the website by using a Django server combined with the powerful Cockroach Database. In the website, we used the REST framework to create a secure API that our native desktop app used to get user information. After that, we had to configure a native desktop app to record and transcribe live audio data coming from the client's class/microphone.

Challenges we ran into

We ran into many challenges during the development of this. One of the main challenges was creating the API backend using many serializers and the rest framework. The next challenge was to create a communication between the desktop app and the website, ensuring that there was no packet loss in the transmission. Also, we had trouble setting up the website server on our personal server using cloud flare and domain.com, but we were able to conquer this by having diligence.

Accomplishments that we're proud of

We are extremely proud of the back and forth connections that we made between the website's API and the native desktop app. We are also proud of the clean UI that we made on the website.

What we learned

We have learned many things during this hackathon, including a new programming language. The main thing that we learned is that having big ideas for a small amount of time isn't good. Also, we have learned that there are detailed documentations for everything on the internet, and they will be extremely helpful. Lastly, we learned an entire framework (pyqt) in order to create the GUI which transcribes and saves audio.

What's next for SpaceOut

Space out will continue to help with student needs and problems in an online environment. We want to ensure that students get a maximum learning experience and are able to stay focused during class, by creating efficient APIs and applications that assist them.