Skip to content

Commit ad9f36b

Browse files
authored
Add postgresql install instructions for psycopg2 (#12)
## Notion ticket link <!-- Give a quick summary of the implementation details, provide design justifications if necessary --> ## Implementation description * Added instructions to the README to install postgresql if users haven't already. You will need this for local development, as encountered by @janealsh. <!-- What should the reviewer do to verify your changes? Describe expected results and include screenshots when appropriate --> ## Steps to test 1. try running instructions and see if `pdm run dev` works properly. ## Checklist - [x] My PR name is descriptive and in imperative tense - [x] My commit messages are descriptive and in imperative tense. My commits are atomic and trivial commits are squashed or fixup'd into non-trivial commits - [x] I have run the appropriate linter(s) - [x] I have requested a review from the PL, as well as other devs who have background knowledge on this PR or who will be building on top of this PR
1 parent a635e0b commit ad9f36b

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,18 +64,18 @@ git clone https://github.com/uwblueprint/llsc.git
6464
cd llsc
6565
```
6666

67-
- Create a .env file in the root directory based on the .env.sample file. Update
67+
- Create a .env file in `./backend` and `./frontend` based on the .env.sample file. Update
6868
the environment variables as needed. Consult the [Secrets](#secrets) section
6969
for detailed instructions.
7070

7171
```bash
7272
cp .env.sample .env
7373
```
7474

75-
- Build and start the Docker containers
75+
- Build and start the Docker containers (in detached mode)
7676

7777
```bash
78-
docker-compose up --build
78+
docker-compose up -d
7979
```
8080

8181
- Install pdm (this is a global installation, so location doesn't matter)
@@ -85,6 +85,14 @@ brew install pdm
8585
```
8686
Otherwise, feel free to follow install instructions [here](https://pdm-project.org/latest/#installation)
8787

88+
- Install postgresql (this is for local development)
89+
On macOS:
90+
```bash
91+
brew install postgresql
92+
```
93+
Otherwise, feel free to follow install instructions [here](https://www.postgresql.org/download/)
94+
Note: you will need this for `psycopg2`, which requires a config file that is part of postgresql.
95+
8896
You will then need to go into each directory individually to install dependencies.
8997

9098
FastAPI backend

0 commit comments

Comments
 (0)