CoWriter

CoWriter is an innovative AI-powered writing assistant designed to enhance writing quality through various actions such as expanding, shortening, and critiquing text. With its user-friendly interface, CoWriter facilitates real-time writing improvements, making it a valuable tool for writers of all skill levels.

Features

• Text Expansion: Utilize AI-generated suggestions to elaborate on ideas, enriching your content.
• Text Shortening: Craft more concise and impactful writing with ease.
• Writing Critique: Receive constructive feedback on your work to refine your writing style.
• Custom Actions: Create personalized actions to aid in writing, such as adding facts or quotes.
• Interactive Chat: Engage in a supportive conversation about your text to brainstorm ideas and solutions.
• Modern UI: Experience a clean and intuitive interface developed with Next.js.
• Flexible AI Backend: Compatibility with both OpenAI and Llama models enhances versatility.

Project Structure

CoWriter is divided into two main components:

• Backend: A FastAPI service that is Python-based and ensures type safety through mypy. The backend is structured for optimal performance, with linting provided by flake8, and formatted using black and isort.
• Frontend: A Next.js application built with React and TypeScript, featuring a beautiful UI designed with Tailwind CSS. It offers real-time editing capabilities through Tiptap and maintains high code quality with ESLint and Prettier.

Development Tools

CoWriter uses several modern development tools to enhance the development experience:

• Backend Development: Developers can utilize Poetry for dependency management and run code quality tools like black, isort, flake8, and mypy for an efficient workflow.
• Frontend Development: The frontend setup includes npm for package management, along with linting and formatting tools to ensure code quality.

API Documentation

CoWriter provides comprehensive API documentation available via Swagger UI at http://localhost:8000/docs and ReDoc at http://localhost:8000/redoc for easy access to endpoints.

CoWriter represents a substantial step forward in integrating AI into the writing process, offering features and tools that foster creativity and productivity. Whether for casual writing or professional content creation, CoWriter is equipped to assist in achieving writing goals efficiently.