@@ -17,25 +17,25 @@ I have documented some of my thought process and engineering decisions while cre
1717
1818## Requirements
1919
20- - [ Python] ( https://www.python.org/ ) 3.9+
21- - [ poetry] ( https://python-poetry.org/docs/ )
22- - [ PostgreSQL] ( https://www.postgresql.org/ )
20+ - [ Python] ( https://www.python.org/ ) 3.9+
21+ - [ poetry] ( https://python-poetry.org/docs/ )
22+ - [ PostgreSQL] ( https://www.postgresql.org/ )
2323
2424## Database
2525
26- - Make sure you have a running instance of the latest PostgreSQL in your local machine
27- - Example to spin up a PostgreSQL Docker instance locally
26+ - Make sure you have a running instance of the latest PostgreSQL in your local machine
27+ - Example to spin up a PostgreSQL Docker instance locally
2828
29- ``` sh
30- docker run -d --name dpostgres -p 5432:5432 -e POSTGRES_HOST_AUTH_METHOD=trust postgres:latest
31- ```
29+ ``` sh
30+ docker run -d --name dpostgres -p 5432:5432 -e POSTGRES_HOST_AUTH_METHOD=trust postgres:latest
31+ ```
3232
33- - Create a new database name as ` burplist`
34- - Ensure that ` pg_trgm` is installed as your PostgreSQL extension
33+ - Create a new database name as ` burplist `
34+ - Ensure that ` pg_trgm ` is installed as your PostgreSQL extension
3535
36- ` ` ` sql
37- CREATE EXTENSION pg_trgm;
38- ` ` `
36+ ``` sql
37+ CREATE EXTENSION pg_trgm;
38+ ```
3939
4040## How to install
4141
@@ -55,8 +55,8 @@ Before you begin your development work, make sure you have installed [pre-commit
5555
5656Some example useful invocations:
5757
58- - ` pre-commit install` : Default invocation. Installs the pre-commit script alongside any existing git hooks.
59- - ` pre-commit install --install-hooks --overwrite` : Idempotently replaces existing git hook scripts with pre-commit, and also installs hook environments.
58+ - ` pre-commit install ` : Default invocation. Installs the pre-commit script alongside any existing git hooks.
59+ - ` pre-commit install --install-hooks --overwrite ` : Idempotently replaces existing git hook scripts with pre-commit, and also installs hook environments.
6060
6161## Optional: Environment variables
6262
@@ -82,11 +82,11 @@ docker start dpostgres
8282## Optional: Using Docker
8383
8484``` sh
85- # make build
86- docker build -t burplist-frontend .
85+ # build docker image.
86+ make build
8787
88- # Run the image in a container
89- docker run -d -p 8080:8080 --name burplist-frontend burplist-frontend
88+ # run local development server in docker.
89+ make run
9090```
9191
9292Your server should be live at to http://localhost:8080 .
0 commit comments