Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
akmamun authored Oct 26, 2023
1 parent b3fc679 commit 0892856
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
### Installation Instructions

- Create a [virtual environment](https://docs.python.org/3/library/venv.html)
- Install the python Dependencies with `pip install -r requirements.txt`
- Install the Python dependencies with
```sh
pip install -r requirements.txt
```
- Copy the .env.example file as .env
```sh
cp .env.example .env
Expand All @@ -12,17 +15,17 @@


### Run Locally
To run the service locally, use the following command:
- To run the service locally, use the following command:
```sh
uvicorn server:app --reload
```

### Run with Docker
To run the service using Docker, use the following command:
```sh
sudo docker-compose up -d --build
```

### Run with Docker
- To run the service using Docker, use the following command:
```sh
sudo docker-compose up -d --build
```
### Run Docker Compose for Production Build
Ensure that you have [Docker]((https://docs.docker.com/engine/install)) and [Docker Compose](https://docs.docker.com/compose/install/) installed.
- Ensure that you have [Docker](https://docs.docker.com/engine/install) and [Docker Compose](https://docs.docker.com/compose/install/) installed

0 comments on commit 0892856

Please sign in to comment.