Skip to content

Commit fcb13f7

Browse files
committed
Clean up README
1 parent af8b3c6 commit fcb13f7

File tree

2 files changed

+19
-17
lines changed

2 files changed

+19
-17
lines changed

.github/workflows/pull_request.yml

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Run this workflow for PRs only to confirm container build is working properly
2+
13
name: Pull request
24

35
on:

README.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -126,31 +126,31 @@ Follow the prompts that follow.
126126

127127
2. Open the following URL
128128
```
129-
http://localhost:8002/beta/openshift/cost-management
129+
http://localhost:8002/beta/openshift/cost-management
130130
```
131131

132132
#### Koku API
133133
Refer to the project [README][koku-readme] for prerequisites
134134

135135
1. Setup & run Koku API (see project [README][koku-readme] for more details)
136136
```
137-
> git clone git@github.com:project-koku/koku.git
138-
> cd [KOKU_GIT_REPO]
139-
> pipenv install --dev
140-
> pipenv shell "pre-commit install"
141-
> make docker-up-min or make docker-up-min-trino
142-
> make create-test-customer
143-
> make load-test-customer-data (use with docker-up-min-trino)
137+
git clone git@github.com:project-koku/koku.git
138+
cd [KOKU_GIT_REPO]
139+
pipenv install --dev
140+
pipenv shell "pre-commit install"
141+
make docker-up-min or make docker-up-min-trino
142+
make create-test-customer
143+
make load-test-customer-data (use with docker-up-min-trino)
144144
```
145145

146146
2. Check to see if containers are running (optional)
147147
```
148-
> docker ps --format "table {{.Names}}\t{{.Image}}\t{{.Ports}}\t{{.Status}}"
148+
docker ps --format "table {{.Names}}\t{{.Image}}\t{{.Ports}}\t{{.Status}}"
149149
```
150150

151151
3. Watch the Koku API logs in another terminal (optional)
152152
```
153-
> docker-compose logs -f koku-server koku-worker
153+
docker-compose logs -f koku-server koku-worker
154154
```
155155

156156
4. Clean up (optional)
@@ -168,21 +168,21 @@ Follow the [steps](#koku-api) to run a local Koku API instance
168168

169169
1. Clone the Settings Frontend repository and install dependencies
170170
```
171-
> git clone https://github.com/RedHatInsights/settings-frontend.git
172-
> cd [SETTINGS_FRONTEND_GIT_REPO]
173-
> npm install
171+
git clone https://github.com/RedHatInsights/settings-frontend.git
172+
cd [SETTINGS_FRONTEND_GIT_REPO]
173+
npm install
174174
```
175175

176176
2. Set the following variables in your environment
177177
```
178-
> export API_PORT=8000
179-
> export LOCAL_API="/api/cost-management/v1/"
180-
> export KEYCLOAK_PORT=4020
178+
export API_PORT=8000
179+
export LOCAL_API="/api/cost-management/v1/"
180+
export KEYCLOAK_PORT=4020
181181
```
182182

183183
3. Start development server
184184
```
185-
> npm run start:standalone:beta
185+
npm run start:standalone:beta
186186
```
187187

188188
4. Open the following URL

0 commit comments

Comments
 (0)