Skip to content

An AI-powered writing assistant website built with a ReactJS frontend and a backend powered by ExpressJS and Python FastAPI.

License

Notifications You must be signed in to change notification settings

FayasNoushad/Writing-Assistant

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Writing Assistant

An AI-powered writing assistant website built with a ReactJS frontend and a backend powered by ExpressJS and Python FastAPI.


Features

  • Grammar Checking: Corrects grammar mistakes in your text.
  • Improvement Suggestions: Provides suggestions to improve your text.

Used Technologies

  • Frontend: ReactJS
  • Backend: ExpressJS, Python FastAPI
  • AI Model: Gemini Pro
  • Database: MongoDB
  • Authentication: JWT

How to run?

Note: Ensure you add your API keys and required environment variables in the .env file as shown in the .env.example file.


Run express.js backend

  1. Go to the backend directory.
    cd backend
  2. Install the required dependencies:
    npm install
  3. Run the following command:
    npm run dev
  4. The backend server will start running on http://localhost:5000.

Run python-backend

  1. Go to the python-backend directory.
    cd backend
  2. Create a virtual environment:
    python3 -m venv .venv
  3. Activate the virtual environment:

    linux command

    . ./.venv/bin/activate
  4. Install the required dependencies:
    pip install -r requirements.txt
  5. Run the following command:
    fastapi run
  6. The backend server will start running on http://localhost:8000.

Run frontend

  1. Go to the frontend directory.
    cd frontend
  2. Install the required dependencies:
    npm install
  3. Run the following command:
    npm run dev
  4. The frontend server will start running on http://localhost:5173.

Screenshots


About

An AI-powered writing assistant website built with a ReactJS frontend and a backend powered by ExpressJS and Python FastAPI.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project

  •