Skip to content

Commit

Permalink
Add postgresql install instructions for psycopg2 (#12)
Browse files Browse the repository at this point in the history
## 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
  • Loading branch information
mslwang authored Nov 30, 2024
1 parent a635e0b commit ad9f36b
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,18 +64,18 @@ git clone https://github.com/uwblueprint/llsc.git
cd llsc
```

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

```bash
cp .env.sample .env
```

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

```bash
docker-compose up --build
docker-compose up -d
```

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

- Install postgresql (this is for local development)
On macOS:
```bash
brew install postgresql
```
Otherwise, feel free to follow install instructions [here](https://www.postgresql.org/download/)
Note: you will need this for `psycopg2`, which requires a config file that is part of postgresql.

You will then need to go into each directory individually to install dependencies.

FastAPI backend
Expand Down

0 comments on commit ad9f36b

Please sign in to comment.