Skip to content

Commit

Permalink
chore: 📝 update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
FilippeMafra committed Jan 18, 2024
1 parent e642f19 commit 1145d89
Showing 1 changed file with 12 additions and 21 deletions.
33 changes: 12 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,17 @@
## Website which convert speech to text by Whisper model ([Official Repo](https://github.com/openai/whisper))
## Docker image builder based on ([Kabanosk Repo](https://github.com/Kabanosk/whisper-website))

## Hosting website on localhost:
[![Docker Image CI](https://github.com/FilippeMafra/whisper-website/actions/workflows/docker-image.yml/badge.svg)](https://github.com/FilippeMafra/whisper-website/actions/workflows/docker-image.yml)

1. Clone the repo - `git clone [email protected]:Kabanosk/whisper-website.git`
2. Go to repo directory - `cd whisper-website`
3. Create virtual environment - `python3 -m venv venv`
4. Activate the environment - `source venv/bin/activate`/`. venv/bin/activate`
5. Install requirements - `pip install -r requirements.txt`
6. Go to src directory - `cd src`
7. Run the `run.py` file - `python3 run.py`
8. Go to your browser and type `http://127.0.0.1:8000/` if the browser doesn't open
## Using the image:

## Run website on localhost with Docker
### First time
1. Install [Docker](https://docs.docker.com/engine/install/)
2. Clone the repo - `git clone [email protected]:Kabanosk/whisper-website.git`
3. Go to repo directory - `cd whisper-website`
4. Create Docker image - `docker build -t app .`
5. Run Docker container - `docker run --name app_container -p 80:80 app`
6. Go to your browser and type `http://127.0.0.1:80/`
Command Line:

### Next time
```
docker pull ghcr.io/filippemafra/whisper-website:main
```

1. Start your Docker container - `docker start app_container`
2. Go to your browser and type `http://127.0.0.1:80/`
Dockerfile:

```
FROM ghcr.io/filippemafra/whisper-website:main
```

0 comments on commit 1145d89

Please sign in to comment.