bonyuta0204 / draftdoctor

AI-powered writing assistant to review and improve your drafts effortlessly.

DraftDoctor

AI-powered writing assistant to review and improve your drafts effortlessly.

Table of Contents

• Features
• Prerequisites
• Installation
  • Direct Installation
  • Using Docker Compose
• Usage
  • Directly Running the Application
• Contributing
• License

Features

• Document review: Checks for grammar, style, and clarity

Prerequisites

• Python 3.x
• Node.js
• Docker (optional)

Installation

Direct Installation

What you'll install

• Poetry for Python package management
• Python dependencies from `pyproject.toml`
• Volta for JS runtime management
• Node.js dependencies
• Django database migrations

1. Install Poetry

   curl -sSL https://install.python-poetry.org | python3

2. Poetry Install

   poetry install

3. Install Volta

   curl https://get.volta.sh | bash

4. Yarn Install

   yarn install

5. Django Migration

   poetry run python manage.py migrate

Using Docker Compose

1. Docker Compose Up

   docker compose up

Usage

Directly Running the Application

Frontend

1. Start the Vite development server.

   yarn dev

Backend

1. Run the Django development server.

   poetry run python manage.py runserver

License

This project is released under the MIT License for both frontend and backend components.