Skip to content

Commit 4b6c0af

Browse files
committed
chore: update README to clarify project directory requirements and adjust command usage
1 parent f2739a7 commit 4b6c0af

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

backend/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ _Image credit to [Thang Chung under MIT terms](https://github.com/thangchung/blo
1818

1919
1. **Pre-requisites:**
2020
- Ensure Python 3.11 is installed
21+
- Ensure that you are in the `backend` directory of the project.
2122

2223
2. **Install uv**
2324
```shell
@@ -82,6 +83,10 @@ _Image credit to [Thang Chung under MIT terms](https://github.com/thangchung/blo
8283
## Setup Serverless Framework
8384
1. **Prerequisites:**
8485
- Node.js 14 or later
86+
- Ensure that you are in the `backend` directory of the project by running:
87+
```shell
88+
cd backend
89+
```
8590
2. **Install Serverless Framework:**
8691
```shell
8792
npm install --save-dev serverless@3
@@ -92,13 +97,13 @@ _Image credit to [Thang Chung under MIT terms](https://github.com/thangchung/blo
9297
```
9398
4. **Install plugins:**
9499
```shell
95-
sls plugin install -n serverless-python-requirements serverless-better-credentials
100+
npx sls plugin install -n serverless-python-requirements serverless-better-credentials
96101
```
97102

98103
## Deploy to AWS
99104
1. **Setup Docker (Non-Linux users only):**
100105
- [Docker Installation Guide](https://docs.docker.com/engine/install)
101-
- Ensure Docker is running
106+
- Ensure Docker is running, **especially for non-Linux users**, as it is required for building the Python dependencies.
102107
2. **Activate virtual environment:**
103108
```shell
104109
# Linux/Mac
@@ -109,7 +114,7 @@ _Image credit to [Thang Chung under MIT terms](https://github.com/thangchung/blo
109114
```
110115
3. **Deploy:**
111116
```shell
112-
AWS_SDK_LOAD_CONFIG=1 sls deploy --stage dev --aws-profile <profile-name> --verbose
117+
AWS_SDK_LOAD_CONFIG=1 npx sls deploy --stage dev --aws-profile <profile-name> --verbose
113118
```
114119

115120
## Docstrings

0 commit comments

Comments
 (0)