Skip to content

Latest commit

 

History

History
62 lines (48 loc) · 4.17 KB

README.md

File metadata and controls

62 lines (48 loc) · 4.17 KB
Raw

2write

Welcome to 2write, a cloud-enabled AI-powered text editor designed for writing essays. This application is built using Mantine, React, Vite and Firebase, with OpenAI's GPT-3 model powering the AI features.

compressed-final.mp4

Features

2write provides a range of features that make it a comprehensive writing platform for students and writers, including:

  • Essay management: Users can view, rename, delete and create new essays from the home page.

home

  • AI-generated snippets: 2write uses OpenAI's GPT-3 model to provide intelligent autocomplete suggestions for faster and more accurate writing.
  • Notepad powered by NLP: The application is powered by natural language processing, allowing for seamless writing experiences.
  • Essay outlines: Users can generate essay outlines by providing 2write with their essay prompt.

edit

  • Rewrite feature: 2write provides a feature that allows users to highlight text and rewrite it with AI, with word count information displayed for the selected text.

rewrite

  • Essay analytics: Users can track word count with or without citations, character count, top words, reading time and sentiment analysis, providing helpful insights into their writing.

analytics

  • Todo list: There is a built-in todo list inside the editor for users to keep track of what they want to do.

todo

  • AI plagiarism report: 2write provides a machine learning-powered plagiarism report that checks if text is written by a human or AI.

aicheck

- File upload: Users can upload files in the .docx format and 2write will let them edit using its editor.

upload

Getting Started

To get started with 2write, follow these steps:

  1. Clone the repository to your local machine.
  2. Install dependencies by running yarn.
  3. Set up a Firebase project and add your Firebase credentials to the .env.local file as:
    • VITE_FIREBASE_API_KEY
    • VITE_FIREBASE_AUTH_DOMAIN
    • VITE_FIREBASE_PROJECT_ID
    • VITE_FIREBASE_STORAGE_BUCKET
    • VITE_FIREBASE_MESSAGING_SENDER_ID
    • VITE_FIREBASE_APP_ID
    • VITE_FIREBASE_MEASUREMENT_ID
    • VITE_FIREBASE_SERVICE_ACCOUNT_KEY
  4. Set up an OpenAI account and add your API key to the .env.local file as VITE_OPENAI_API_KEY.
  5. If you want email notifications for when OpenAI credits run out, create a SendGrid account and add the API key to the .env.local file as VITE_SENDGRID_API_KEY.
  6. Run the development server by running yarn dev.
  7. Navigate to http://localhost:3000 to view the application.

Technologies

  • Mantine - Fully Featured React Component Library
  • React - JavaScript library for building user interfaces
  • Vite - Build tool for modern web projects
  • Firebase - Backend for authentication and database
  • OpenAI - Running fine-tuned and GPT-3 models

Getting Help

If you have any questions or run into any issues with 2write, please feel free to reach out to our team by opening an issue on our GitHub repository. We are always happy to help and are committed to providing a positive experience for all users of our application.

Contributing

If you're interested in contributing to 2write, we welcome your contributions!