Skip to content

Commit

Permalink
move frontend to root for deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
CuriousDima committed May 26, 2024
1 parent 8d85e21 commit 174e060
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 15 deletions.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,22 @@ It is freely available. Go ahead and give it a try: https://t.me/PardonMyEnglish
Pardon My English is designed to assist non-native English speakers by transforming semantically incorrect or awkwardly phrased English text into grammatically accurate and fluent English. Users simply input their original text, and the bot efficiently processes and returns a polished version, enhancing clarity and coherence. Ideal for learners of English, professionals, and anyone looking to improve their written communication.

# Changelog
- \[2024-05-25\] We've added an alternative frontend. Instead of using Telegram, you can now run the app locally by using `streamlit run frontend/app.py` command, and interact with Pardon My English in the same way as before.

- \[2024-05-25\] We've added an alternative frontend. Instead of using Telegram, you can now run the app locally by using `streamlit run frontend.py` command, and interact with Pardon My English in the same way as before.
- \[2024-04-24\] We've transitioned to using Llama3-70B for all existing and new users, and have seen significant improvements in quality without any degradation in inference speed, thanks to the capabilities of [Groq](https://groq.com/).

# Web UI

If you want to run the app locally, start by creating the `secrets.toml` file:

```shell
touch ~/.streamlit/secrets.toml
```

You'll need to obtain a Groq API key, which you'll then provide in the "secrets.toml" file as a `GROQ_API_KEY`.

After specifying the API key in the secrets file, you can proceed to run the web UI locally:

```shell
streamlit run frontend.py
```
2 changes: 0 additions & 2 deletions frontend/app.py → frontend.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
import os
import sys
import time

import streamlit as st

sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
from common.llm_client import LLMClient, Model, Provider

# Set environment variables from secrets.
Expand Down
11 changes: 0 additions & 11 deletions frontend/README.md

This file was deleted.

Empty file removed frontend/__init__.py
Empty file.
1 change: 0 additions & 1 deletion frontend/secrets.toml.template

This file was deleted.

0 comments on commit 174e060

Please sign in to comment.