fixing readme + .env.examples for each service + infra

This commit is contained in:
Kfir Dayan 2023-07-08 02:03:44 +03:00
parent 6b7abad013
commit a2329d497c
4 changed files with 37 additions and 2 deletions

View file

@ -41,7 +41,7 @@ npm run dev
``` ```
## TodoService ## TodoService
Before running the TodoService, ensure that you have Node.js, TypeScript (tsc), configured aws-cli and npm installed. Before running the TodoService, ensure that you have Node.js, TypeScript (tsc) and npm installed.
Navigate to the /todo-service directory. Navigate to the /todo-service directory.

View file

@ -1,3 +1,10 @@
## ROOT ##
MONGO_INITDB_DATABASE=your-database-name MONGO_INITDB_DATABASE=your-database-name
MONGO_INITDB_ROOT_USERNAME=your-username MONGO_INITDB_ROOT_USERNAME=your-username
MONGO_INITDB_ROOT_PASSWORD=your-password MONGO_INITDB_ROOT_PASSWORD=your-password
## Todo User ##
DB_USERNAME=user
DB_PASSWORD=12345
DB_NAME=user_db
DB_USER_ROLE=readWrite

View file

@ -0,0 +1,10 @@
## AWS-SDK ##
AWS_ACCESS_KEY_ID={AWS_ACCESS_KEY_ID}
AWS_SECRET_ACCESS_KEY={AWS_SECRET_ACCESS_KEY}
AWS_REGION={AWS_REGION}
AWS_SQS_URL=https://sqs.{AWS_REGION}.amazonaws.com/{ACCOUNT_ID}/
AWS_SQS_QUEUE_NAME={NAME_OF_QUEUE}
## MONGO USER ##
DATABASE_URL=mongodb://{USER}:{PASSWORD}@localhost:27017/{DB_NAME}
MONGO_DB_NAME={USER_DB_NAME}

18
todo-service/.env.example Normal file
View file

@ -0,0 +1,18 @@
#### MONGODB ####
## TODO MONGO USER ##
PORT={PORT}
DATABASE_URL=mongodb://{USER}:{PASSWORD}@localhost:27017/{DB_NAME}
MONGO_DB_NAME={USER_DB_NAME}
## MONGO_ROOT ##
MONGO_INITDB_DATABASE={DB_NAME}
MONGO_INITDB_ROOT_USERNAME={USER}
MONGO_INITDB_ROOT_PASSWORD={PASSWORD}
## AWS-SDK ##
AWS_ACCESS_KEY_ID={AWS_ACCESS_KEY_ID}
AWS_SECRET_ACCESS_KEY={AWS_SECRET_ACCESS_KEY}
AWS_REGION={AWS_REGION}
AWS_SQS_URL=https://{AWS_REGION}.amazonaws.com/{ACCOUNT_ID}/
AWS_SQS_QUEUE_NAME={NAME_OF_QUEUE}