Skip to content

Commit

Permalink
docs(readme): update readme with console instead of bash (#5970)
Browse files Browse the repository at this point in the history
  • Loading branch information
pedrooot authored Nov 29, 2024
1 parent f6187ee commit e09a04d
Showing 1 changed file with 27 additions and 27 deletions.
54 changes: 27 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,9 @@ Prowler App can be installed in different ways, depending on your environment:

**Commands**

``` bash
curl -Lo https://github.com/prowler-cloud/prowler/blob/master/docker-compose.yml \
curl -Lo https://github.com/prowler-cloud/prowler/blob/master/.env \
``` console
curl -Lo https://github.com/prowler-cloud/prowler/blob/master/docker-compose.yml
curl -Lo https://github.com/prowler-cloud/prowler/blob/master/.env
docker compose up -d
```

Expand All @@ -111,41 +111,41 @@ docker compose up -d

**Commands to run the API**

``` bash
git clone https://github.com/prowler-cloud/prowler \
cd prowler/api \
poetry install \
poetry shell \
set -a \
source .env \
docker compose up postgres valkey -d \
cd src/backend \
python manage.py migrate --database admin \
``` console
git clone https://github.com/prowler-cloud/prowler
cd prowler/api
poetry install
poetry shell
set -a
source .env
docker compose up postgres valkey -d
cd src/backend
python manage.py migrate --database admin
gunicorn -c config/guniconf.py config.wsgi:application
```

> Now, you can access the API documentation at http://localhost:8080/api/v1/docs.
**Commands to run the API Worker**

``` bash
git clone https://github.com/prowler-cloud/prowler \
cd prowler/api \
poetry install \
poetry shell \
set -a \
source .env \
cd src/backend \
``` console
git clone https://github.com/prowler-cloud/prowler
cd prowler/api
poetry install
poetry shell
set -a
source .env
cd src/backend
python -m celery -A config.celery worker -l info -E
```

**Commands to run the UI**

``` bash
git clone https://github.com/prowler-cloud/prowler \
cd prowler/ui \
npm install \
npm run build \
``` console
git clone https://github.com/prowler-cloud/prowler
cd prowler/ui
npm install
npm run build
npm start
```

Expand Down Expand Up @@ -185,7 +185,7 @@ The container images are available here:

Python >= 3.9, < 3.13 is required with pip and poetry:

```
``` console
git clone https://github.com/prowler-cloud/prowler
cd prowler
poetry shell
Expand Down

0 comments on commit e09a04d

Please sign in to comment.