Skip to content

Commit

Permalink
Update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
mslwang committed Nov 26, 2024
1 parent 29286bd commit 1b186a7
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ 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.

Expand Down
24 changes: 16 additions & 8 deletions backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,25 +17,26 @@ Ensure you have the following installed on your machine:
```
- **Docker**
## Installation
Once PDM is installed, install the project dependencies by running:
- Create a `.env` file in `./backend` (the root directory, not in the backend folder) based on the .env.sample file. Update
the environment variables as needed. Consult the [Secrets](#secrets) section
for detailed instructions.
```bash
pdm install
cp .env.sample .env
```
to install all the project dependancies listed in the `pyproject.toml` file.
## Installation
## Running the Backend Locally
To start the backend locally, use the following command:
Once PDM is installed, install the project dependencies by running:
```bash
pdm run dev
pdm install
```
Note: If you wish to run the backend outside of Docker (e.g., for local development), you'll need to set up a PostgreSQL database. Ensure your database configuration is set properly in the environment variables before running the project.
to install all the project dependancies listed in the `pyproject.toml` file.
## Running the Backend Locally
To start up the database using docker, run the following command:
```bash
cd backend
Expand All @@ -48,6 +49,13 @@ To check if the database has been started up, type the following:
```
This checks the list of docker containers and searchs for the container name `llsc_db_dev_local`
Note: If you wish to run the backend outside of Docker (e.g., for local development), you'll need to set up a PostgreSQL database. Ensure your database configuration is set properly in the environment variables before running the project.

To start the backend locally, use the following command:

```bash
pdm run dev
```
## Run Project

Take advantage of the docker compose file in the LLSC root directory to run the backend alongside the frontend by simply running
Expand Down

0 comments on commit 1b186a7

Please sign in to comment.