https://github.com/zakharb/aireading
Easy read text and learn new words with OpenAI
https://github.com/zakharb/aireading
chatgpt css fastapi javascript openai python3 reading webdesign
Last synced: 8 months ago
JSON representation
Easy read text and learn new words with OpenAI
- Host: GitHub
- URL: https://github.com/zakharb/aireading
- Owner: zakharb
- License: gpl-3.0
- Created: 2023-03-07T14:58:30.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-26T10:14:48.000Z (about 3 years ago)
- Last Synced: 2025-04-06T19:11:12.293Z (about 1 year ago)
- Topics: chatgpt, css, fastapi, javascript, openai, python3, reading, webdesign
- Language: CSS
- Homepage:
- Size: 8.26 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## :red_square: Getting Started
[AIreading](https://github.com/zakharb/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](https://aireding-1-x9379886.deta.app/) where you can try it!
### Requirements
### Install and run
Clone the project
```sh
git clone git@github.com:zakharb/aireading.git
cd aireading
```
Create API key on [OpenAI site](https://platform.openai.com/account/api-keys)
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](http://localhost:8080) by address
```
http://localhost:8080
```
## :red_square: Deployment to Deta
Deployment is described in this [gudie](https://deta.space/docs/en/basics/cli)
Install Deta Space CLI
```sh
curl -fsSL https://get.deta.dev/space-cli.sh | sh
```
Generate an access token on [Space dashboard](https://deta.space/)
Login to Deta Space
```sh
space login
```
Go to folder and create project
```sh
cd aireading
space new
```
Push the project
```sh
space push
```
## :red_square: Versioning
Using [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/zakharb/syslogen/tags).
## :red_square: Authors
* **Zakhar Bengart** - *Initial work* - [Ze](https://github.com/zakharb)
See also the list of [contributors](https://github.com/zakharb/syslogen/contributors) who participated in this project.
## :red_square: 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](LICENSE) file for details