WriteVibe is the place to go if you're sick and tired of your boring writing applications... you know which ones I'm talking about. Enojoy a full suite of text formatting options as well as complete writing enviroment control!
Explore the docs »

View Demo

Table of Contents

1. About The Project
2. Built With
3. Installing and Running
4. Roadmap
5. License
6. Contact
7. Acknowledgments

About The Project

This web application is designed to serve a specific demographic, namely individuals within the neurodivergent spectrum, particularly those diagnosed with Attention-Deficit/Hyperactivity Disorder (ADHD), who frequently struggle to maintain focus during mundane or unstimulating tasks. While individuals categorized as neurotypical can generally concentrate sufficiently on tasks at hand, those within the neurodivergent spectrum may necessitate additional stimuli to initiate and maintain focus. The primary objective of this web application is to provide tailored cognitive stimulation, particularly applicable to prolonged writing activities. thereby ensuring sustained engagement among individuals with ADHD. Beyond addressing the challenges associated with ADHD, the application’s functionality extends to a broader user base seeking enhanced levels of customization, personalization, and overall enjoyment in their writing endeavors. In doing so, it surpasses the capabilities offered by conventional word processors like Microsoft Word and Google Docs.

(back to top)

Built With

• 
• 
• QuillJS
• ConvertAPI
• 
• 
• 

Packages

1. @mui/icons-material: ^5.15.14
2. @mui/material: ^5.15.13
3. @testing-library/jest-dom: ^5.17.0
4. @testing-library/react: ^13.4.0
5. @testing-library/user-event: ^13.5.0
6. convertapi-js: ~1.1
7. file-saver: ^2.0.5
8. notistack: ^3.0.1
9. path-browserify: ^1.0.1
10. quill-to-pdf: ^1.0.7
11. quill-to-word: ^1.3.0
12. react: ^18.2.0
13. react-confetti-explosion: ^2.1.2
14. react-dom: ^18.2.0
15. react-full-screen: ^1.1.1
16. react-quill: ^2.0.012

Installing and Running

1. Clone the repo

   git clone https://github.com/chenweida6220/csci-49900-writevibe

2. Install NPM packages

   npm install

3. Install ConvertAPI

   npm i convertapi-js@~1.1

4. Deploy the application

   npm start

(back to top)

Roadmap

• Core Writing Features
  • Text Input
    • Ability to add text by typing.
    • Real-time display of characters as they are typed.
  • Text Deletion
    • Ability to delete text using backspace/delete key.
    • Continuous deletion when the backspace/delete is held down.
  • Basic Formatting
    • Bold, Italics, Underline.
    • Apply multiple formatting styles (e.g., bold and underlined).
    • Change font style/type from dropdown menu.
    • Apply font size from a dropdown menu.
    • Apply changes to all text or selected text.
    • Change text color from a selection in a dropdown menu.
    • Apply color changes to all text or selected text.
    • Highlight text using different colors.
    • Indent text using the tab key.
    • Create bullet and numbered lists with one-tab spacing.
    • Adjust line spacing (single, 1.5 lines, double).
• Embedding Images
  • Embed images in JPEG, JPG, PNG, BMP formats.
  • Paste images from import file.
• Settings Customization
  • Open existing files and save as a new file.
  • Change themes
    • Themes
      • Choose from a variety of animated themes.
      • Themes with preset music and ambient sounds.
      • Change background color or set a background image.
      • Change page color.
      • Set custom sounds for typing, word count goals, and ambient writing sounds.
  • Adjust various settings from a settings overlay menu.

(back to top)

License

Copyright (c) 2024 WriteVibe Creators

Permission is hereby granted, free of charge, to any awesome person obtaining a copy of this software and associated documentation files (the "Software"), to vibe with the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this groovy permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

(back to top)

Contact

• Amy Ta - amy.ta59@myhunter.cuny.edu
• Daniel Maxime - daniel.maxime32@myhunter.cuny.edu
• Uriel Trejo - uriel.trejo71@myhunter.cuny.edu
• Wei Da Chen - weida.chen27@myhunter.cuny.edu

Project Link: https://github.com/chenweida6220/csci-49900-writevibe

(back to top)

Acknowledgments

• Amy Ta
• Daniel Maxime
• Uriel Trejo
• Wei Da Chen

(back to top)