💡 Inspiration

It's no secret that teachers in America are underfunded and underpaid. It's common for teachers to spend much of their free time grading student work and developing lesson plans. As a former (and honestly probably still) bad student (Ryan), my guilt has driven my team to build Nook Notes -- a platform to easily build custom teaching aides, homework, and tests for students.

🛠️ What it does

Currently, the web app is mostly non functional. However, the intent of our web app is for users to upload educational material/scholastic content, which will then get processed into a vector db. Then, when a user prompts our site to generate custom tests/homework, we grab the data from our Vector DB to give an LLM provider/API context to create accurate coursework.

🔧 How we built it

Our web app is a pretty standard SPA, running the MERN stack. Additional APIs/services used (or at least intended to be used) are the Gemini API, Auth0 to handle user authentication, MongoDB for both their key-value NoSQL DB and Vector DB, and Uploadthing as an S3 bucket. For styling, we chose to use the ShadCN UI component library with TailwindCSS.

⚠️ Challenges we ran into

Due to the complexity of the project, we managed to build up the frontend, with the only backend features complete being authentication of our backend routes and partial integration of the Uploadthing API.

🏆 Accomplishments that we're proud of

We created a beautiful, minimalistic frontend that is both modern and intuitive. The teal accents add a bold visual flavor.

📚 What we learned

This project taught us how authentication is implemented throughout the stack. We also learned how web apps manage and store data. Several team members had the opportunity to rigorously practice GitHub actions.

🚀 What's next for Nook Notes?

We plan to finish the features we initially wanted to implement. Despite its current state, we believe in the Nook Notes mission of helping educators everywhere.

Built With

Share this project:

Updates