🟥 Getting Started

AIreading is the simple tool to work with text using OpenAI like ChatGPT. It helps to find vocabulary in the text, generate short description and main idea for text and suggest to you similar stories.

Online Demo site where you can try it!

Requirements

Install and run

Clone the project

git clone [email protected]:zakharb/aireading.git
cd aireading

Create API key on OpenAI site

Write created API key to OPENAI_API_KEY variable into docker-compose.yml file

services:
  aireading:
    build: ./aireading
    command: uvicorn app.main:app --host 0.0.0.0 --port 8080 --forwarded-allow-ips=* --proxy-headers
    volumes:
      - ./aireading/:/app/
    environment:
      - OPENAI_API_KEY=sk-asjhdAWEhw781h2ih2UIHADG@G3792q1u23hiUWHAUWEhiq  

Start docker-compose

docker-compose up -d --build

Open site locally by address

http://localhost:8080

🟥 Deployment to Deta

Deployment is described in this gudie

Install Deta Space CLI

curl -fsSL https://get.deta.dev/space-cli.sh | sh

Generate an access token on Space dashboard

Login to Deta Space

space login

Go to folder and create project

cd aireading
space new

Push the project

space push

🟥 Versioning

Using SemVer for versioning. For the versions available, see the tags on this repository.

🟥 Authors

• Zakhar Bengart - Initial work - Ze

See also the list of contributors who participated in this project.

🟥 License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation - see the LICENSE file for details