Skip to content

Commit 9bb361b

Browse files
authored
docs: add google sheets storage implementation reference in readme
1 parent e81cbd4 commit 9bb361b

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ API_URL=https://something.com/api/
1010
ENVIRONMENT=dev
1111
```
1212
> **_NOTES:_**
13-
> - `API_URL` is referring to the endpoint used to actually access/modify the data.
13+
> - `API_URL` is referring to the endpoint used to actually access/modify the storage data.
1414
> - `ENVIRONMENT` can be filled with `dev` or `prod`.
1515
1616
Available API path:
@@ -23,6 +23,20 @@ Available API path:
2323
- GET http://localhost:3000/wedding/message?page=:page&pageSize=:pageSize
2424
- GET http://localhost:3000/wedding/message/range?offset=:offset&rangeSize=:rangeSize
2525

26+
## Google sheets storage implementation
27+
28+
I forked my production storage implementation in these public google sheets and appscript link for reference:
29+
- Storage google sheets [link](https://docs.google.com/spreadsheets/d/1WQaAei843mCgEapI-Ev11O6pRD5W3wtMDljZb7hilMw/edit?usp=sharing) (note: custom script to generate data id exist inside as well)
30+
- Storage endpoint [link](https://script.google.com/d/1_5qAn7WSTUqnANZgh0KlOMbslwa4la3nGS45PoegDpvz2igAp9No9qEi/edit?usp=sharing)
31+
32+
When using this endpoint, you need to deploy the script to be accessible and then use the endpoint URL as the `API_URL`, for example:
33+
34+
```ini
35+
PORT=3000
36+
API_URL="https://script.google.com/macros/s/AKfycbzLx_IdnCXupFaFxqOVN4-0wPk4J-LMEw5g6ROX0RlphEWQb0NcNWI4hQfApcW9gx0K6g/exec"
37+
ENVIRONMENT=dev
38+
```
39+
2640
## Running the project
2741

2842
> **_NOTE:_** this is only a template from NodeJS project creation. To properly deploy this project in **production**, you need to follow the [git submodule's parent](https://github.com/mastree/wedding-site-app) docker command.\

0 commit comments

Comments
 (0)