Improve text/code AI

The goal of this project is to provide a user-friendly interface for editing and modifying text and code using ChatGPT. This project is built using the Django framework and several other libraries.

Features

• Responsive design for all types of devices (mobile, tablet, desktop) using Bootstrap 5
• Improve text/code using ChatGPT
• Summarize/correct grammar or perform other operations using ChatGPT
• Minify/beautify or perform other operations using ChatGPT
• User registration and login functionality
• History of operations
• Docker support for easy deployment

Built with

• Django - Backend server-side web framework
• Celery - Simple, flexible, and reliable distributed system for processing messages
• Daphne - HTTP, HTTP2, and WebSocket protocol server for ASGI and ASGI-HTTP, used to power Django Channels
• Visual Studio Code - Code editing environment
• pre-commit - Framework for managing and maintaining multi-language pre-commit hooks
• black - Python code formatter
• Flake8 - Python tool for checking code style and quality
• Bootstrap 5 - Frontend toolkit for building responsive designs
• Sass - CSS preprocessor language
• JavaScript - Programming language for enhancing interactivity on the web
• Docker - Platform for delivering software in containers
• Nginx - Web server and reverse proxy
• PostgreSQL - Relational database management system
• OpenAIAPI - API for accessing new AI models developed by OpenAI

Build

Step 1: Download or clone this repository using the following link:

https://github.com/TBR-Group-software/improve-text-AI-app.git

Step 2: Create a .env file in the root folder and specify the following values:

POSTGRES_DB='XXX'
POSTGRES_USER='XXX

POSTGRES_PASSWORD='XXX'
POSTGRES_HOST='localhost'
POSTGRES_PORT=5432

DJANGO_DEBUG=True/False
DJANGO_ALLOWED_HOSTS='*'
DJANGO_SECRET_KEY='XXX'

OPENAI_API_KEY='sk-XXX'
OPENAI_ENGINE='gpt-3.5-turbo' # or another engine

Step 3:

If you want to launch with Docker:

docker-compose up --build

The Improve text/code AI project is now available at http://127.0.0.1/.

Launch without Docker:

Step 1: Create and activate a Python virtual environment:

python3 -m venv env
. env/bin/activate

Step 2: Install the dependencies listed in requirements-dev.txt:

pip3 install -r requirements-dev.txt

Step 3: Run PostgreSQL.

Step 4: Apply Django database migrations:

python3 manage.py migrate

Step 5: Run the Django server:

python3 manage.py runserver

The Improve text/code AI project is now available at http://127.0.0.1:8000/.

License

This project is licensed under the GNU GPL v3 License. See the LICENSE.md file for details.