https://github.com/fayasnoushad/writing-assistant
An AI-powered writing assistant website built with a ReactJS frontend and a backend powered by ExpressJS and Python FastAPI.
https://github.com/fayasnoushad/writing-assistant
express-js fastapi gemini-api mern-stack react writing-assistant writing-tool
Last synced: 6 months ago
JSON representation
An AI-powered writing assistant website built with a ReactJS frontend and a backend powered by ExpressJS and Python FastAPI.
- Host: GitHub
- URL: https://github.com/fayasnoushad/writing-assistant
- Owner: FayasNoushad
- License: mit
- Created: 2025-03-01T02:50:26.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-03-01T03:43:57.000Z (8 months ago)
- Last Synced: 2025-04-12T06:42:51.114Z (6 months ago)
- Topics: express-js, fastapi, gemini-api, mern-stack, react, writing-assistant, writing-tool
- Language: JavaScript
- Homepage:
- Size: 135 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.
```bash
cd backend
```
2. Install the required dependencies:
```bash
npm install
```
3. Run the following command:
```bash
npm run dev
```
4. The backend server will start running on `http://localhost:5000`.
#### Run python-backend
1. Go to the `python-backend` directory.
```bash
cd backend
```
2. Create a virtual environment:
```bash
python3 -m venv .venv
```
3. Activate the virtual environment:
> linux command
```bash
. ./.venv/bin/activate
```
4. Install the required dependencies:
```bash
pip install -r requirements.txt
```
5. Run the following command:
```bash
fastapi run
```
6. The backend server will start running on `http://localhost:8000`.
#### Run frontend
1. Go to the `frontend` directory.
```bash
cd frontend
```
2. Install the required dependencies:
```bash
npm install
```
3. Run the following command:
```bash
npm run dev
```
4. The frontend server will start running on `http://localhost:5173`.
---
## Screenshots
---