Git Product home page Git Product logo

loudxical's Introduction

💡Inspiration

Ever thought about building your own Google Docs? How about incorporating a Notion liked editor on your app? You can choose to build these things from scratch or do the wiser thing by using Lexical's text editor. Lexical is a extensible text editor framework that has 3 main qualities: reliability, accessibility, and speed.

Lexical is used by 100s of applications around the world. Some of its applications include a text editor that may be used by users to write long-form content (for example: blog, essays, research paper). For these users, features associated with spell-checking and proof-reading are very important, since more mistakes are made for long-form content.

Inspire by famoua children's book author Jim Trelease, who once said "The more you read out loud your writing, the better you get it," we decided to build Text-to-Speech(TTS) functionality within Lexical. TTS allows users get to hear their writing before submission and this has a number of benefits:

  1. Users can identify the tone of the piece and the transitions between ideas
  2. User can correct awkward sentences
  3. Users can find spelling mistakes

We decided to call our version of Lexical: Loudxical

x.png

🤔What it does

Loudxical is a web application and comprises of an extension of Lexical editor with TTS functionality within the editor.

Loudxical has all the functionalities of the "rich text editor" Lexical along with several features associated TTS.

y.png

🦾 How we built it

  • Frontend: React.js, Tailwind
  • Packages: Lexical
  • Deployment: Vercel
  • Tools: Vercel, Git

z.png

🎨UI/UX

Our Figma file consists of Mockups and Design Documents we used to build our application.

We were heavily inspired by the revised version of Iterative design process, which not only includes visual design, but a full-fledged research cycle in which you must discover and define your problem before tackling your solution & then finally deploy it.

Double-Diamond

  1. Discover: a deep dive into the problem we are trying to solve.
  2. Define: synthesizing the information from the discovery phase into a problem definition.
  3. Develop: think up solutions to the problem.
  4. Deliver: pick the best solution and build that.

We utilized design tools like Figma to prototype our designs before doing any coding. Through this, we are able to get iterative feedback so that we spend less time re-writing code.

Screenshot-2022-09-25-193955.jpg

📚Research

Research is the key to empathizing with users: we found our specific user group early and that paves the way for our whole project. Here are a few of the resources that were helpful to us —

🤖 Top Software Engineering Project

Our entire project is built on top of Lexical and this hackathon may potentially end up be our first contribution to the project!

🌐 Check it out

🏅 Accomplishments that we're proud of

We are proud of finishing the project on time which seemed like a tough task as we had so many features to implement. Moreover, we learned a lot about GitHub Projects, Assembly AI, new web technologies, and libraries that we could incorporate into our project to meet our unique needs. And as always, working overnight was pretty fun! :)

🧠 Challenges we ran into

This project was especially an achievement for us because this time the experience was very different than what we have while building typical hackathon projects, which also includes heavy brainstorming, extensive research, and yes, hitting the final pin on the board.

We also had to learn Lexical very quickly and style our feature well in Lexical editor's design style.

📖 What we learned

Proper sleep is very important! :p Well, a lot of things, both summed up in technical & non-technical sides. **How Lexical works ** This project gave us a great way introduction to Lexical and let us understand how the project is structured. This will surely fast-track our progress in this fellowship and help us make more contributions!

🚀 What's next for Loudxical

We hope to revisit Loudxical and make it a proper plugin and make a PR and contribute to Lexical

loudxical's People

Contributors

akmarzhan1 avatar gaurang-1402 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.