Skip to content

Commit 2133bd2

Browse files
committed
docs: minor improvements and corrections
1 parent 997dd0e commit 2133bd2

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Now, no matter if you choose the local setup or the docker one, you will need a
4040
E.g. Install it from pip:
4141
```bash
4242
python3 -m venv env
43-
sourc env/bin/activate
43+
source env/bin/activate
4444
pip install pre-commit
4545
```
4646
After it's installed, run `pre-commit install` in the project root folder to see if everything gets initialised correctly. `pre-commit run --all-files` will run it against the whole repository.
@@ -77,7 +77,7 @@ After that, follow the steps below to get started running the project using cont
7777
docker compose up --build
7878

7979
# Once that's finished, from another shell, query the /api/all route to see if everything's there
80-
curl https://localhost:8000/api/all
80+
curl http://localhost:8081/api/all
8181
```
8282

8383
### 3B. Manual requirements
@@ -151,4 +151,4 @@ python3 manage.py runscript sync_db
151151

152152
Now that you have your Homebrew Hub backend up and running, you can check [Virens](https://github.com/gbdev/virens), our VueJS based frontend shipping web assembly builds of mGBA and binjgb to actually play all these entries directly on a browser :D
153153

154-
Remember to set `BASE_API_URL=http://localhost:8000` so the API calls from Virens will point to the backend we just brought up.
154+
Remember to set `BASE_API_URL=http://localhost:8081` so the API calls from Virens will point to the backend we just brought up.

docker-compose.yml

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
version: "3"
2-
31
services:
42
nginx:
53
container_name: hh_nginx
@@ -23,6 +21,7 @@ services:
2321
- postgres:/data/postgres
2422
restart: unless-stopped
2523
healthcheck:
24+
# so that db won't appear as ready when still booting
2625
test: ["CMD-SHELL", "pg_isready -U postgres"]
2726
interval: 1s
2827
timeout: 10s
@@ -31,7 +30,7 @@ services:
3130
- "5432:5432"
3231

3332
pgadmin:
34-
# pgAdmin can access the postgres db with "db" as host and
33+
# From pgAdmin, you can access the postgres db with "db" as host and
3534
# "POSTGRES_USER" and "POSTGRES_PASSWORD" as credentials
3635
# (specified just above in the db service)
3736
container_name: hh_pgadmin

0 commit comments

Comments
 (0)