Skip to content

prasoonkandel/essay_buddy

Repository files navigation

Essay Buddy

A simple AI assistant which can help you write essays.

## Features
  • Generates an essay on your desired topic.
  • Lets you choose the length of essay according to your need.
  • You provide additional description if you want.
  • Responsive UI and design.
  • Beautiful custom cursor and cursor nimation in UI.
  • Felxible backend if want to use this locally.

Tech Stack:

Web UI Screenshot:

Screenshot

Project Setup Guide:

  1. Clone the repository
git clone https://github.com/prasoonkandel/essay_buddy.git

cd essay_buddy
  1. Install dependencies
pip install -r requirements.txt
cd frontend
npm installl
  1. Configure environment

Create a .env file in the project root and add:

AI_URL=https://your-ai-provider-endpoint

AI_KEY=your_api_key_here

AI_MODEL=your_model_name

Create a .env file in the frontend dir and add:

API_BASE_URL=https://your-backend-url.com/

# Example: http://localhost:5000/
  1. Run the app (new terminal)
python app.py
  1. Run frontend (new terminal)
cd frontend
npm run devv

How this works:

  • The frontend calls the api of our backend.
  • The backend recieves the data from api call.
  • It processes the data and creates a prompt.
  • The essayGenerator then calls a LLM API.
  • The Backend then sends the generated essay to frontend.
  • Frontend then displays the essay beautifully.

Built By Prasoon Kandel

About

A simple AI assistant which can help you write essays.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published