Inspiration
As a team of college students and budding software engineers, we often faced the challenge of sharing code snippets, project ideas, or documentation with our teammates before making a formal pull request (PR). The available platforms either required account creation, were too cumbersome for quick edits, or lacked real-time collaboration features. Inspired by our own frustrations and the need for a seamless, intuitive way to collaborate on markdown files, we created NoteFlicks. Our goal was to build a tool that not only served our needs but also addressed a broader challenge in the collaborative documentation and coding space.
What it does
NoteFlicks is a platform where users can create markdown files, share them through a unique URL, and view others' notes in real time without having to make an account. Designed with simplicity and efficiency in mind, it's perfect for sharing code snippets, project documentation, and ideas quickly among team members. Whether it's for reviewing a piece of code before a PR or jotting down notes in a team meeting, NoteFlicks facilitates instant collaboration and sharing.
How we built it
The backend, built with next.js, interfaces with a MongoDB / Firebase databases for storing notes. We also used next.js (react) to build our user interface layer that interacts with our APIs.
Challenges we ran into
Implementing real-time collaborative editing posed significant challenges, especially ensuring that multiple edits by different users didn't lead to data inconsistency or loss. We also strived to make the platform as accessible as possible, which meant creating a user-friendly interface that could cater to users with varying levels of markdown proficiency. Also, the fact that users do not need accounts made some aspects a bit complicated, so we're storing userid locally in their browsers.
Accomplishments that we're proud of
We are very proud and excited how NoteFlicks has lowered barriers for collaboration within a team in a collaborative settings. We're also proud of how we were able to collaborate throughout the development process and the project turned out to be very robust and most importantly useful.
What we learned
We gained deeper understandings in complexities of real-time data synchronization and collaborative editing systems. We had no idea how complex these collaborative editing systems were, for example google docs, notion, etc. Working as a team, we also learned project management and communication skills, as well as how to effectively collaborate and distribute tasks among ourselves.
What's next for NoteFlicks
What we envision for next step is to implement commenting feature where a viewer can add comments to any line of the note allowing to give feedback to the editor in realtime. We believe that this will be a significant improvement from what we have since we currently don't offer commenting feature and we believe that providing feedback in real time will greatly enhance the collaborative experience on NoteFlicks. This addition will not only facilitate a more interactive dialogue between creators and viewers but also streamline the feedback process, making it more efficient and dynamic.
Log in or sign up for Devpost to join the conversation.