66 lines
1.6 KiB
Markdown
66 lines
1.6 KiB
Markdown
|
# Project Setup Instructions
|
||
|
|
|
||
|
|
This README.md file provides instructions for setting up and running various components of the project, including MongoDB, SQS, NotificationService, and TodoService. Please follow the steps below to get started.
|
||
|
|
|
||
|
|
## MongoDB/Docker
|
||
|
|
|
||
|
|
1. Install MongoDB if you haven't already.
|
||
|
|
2. Navigate to the `/infra/docker/docker-compose` directory.
|
||
|
|
3. Run the following command to start MongoDB using Docker Compose:
|
||
|
|
|
||
|
|
```shell
|
||
|
|
docker-compose up -d
|
||
|
|
```
|
||
|
|
|
||
|
|
## SQS/Terraform
|
||
|
|
Before proceeding, ensure that you have Terraform installed and have configured AWS CLI with the keys of an authorized user.
|
||
|
|
|
||
|
|
1. Navigate to the /infra/terraform directory.
|
||
|
|
|
||
|
|
2. Run the following command to initialize Terraform:
|
||
|
|
```terraform
|
||
|
|
terraform init
|
||
|
|
```
|
||
|
|
3. Run the following command to apply the Terraform configuration:
|
||
|
|
```terraform
|
||
|
|
terraform apply
|
||
|
|
```
|
||
|
|
|
||
|
|
## NotificationService
|
||
|
|
Before running the NotificationService, ensure that you have Node.js, TypeScript (tsc), and npm installed.
|
||
|
|
|
||
|
|
Navigate to the /notification-service directory.
|
||
|
|
|
||
|
|
Run the following command to install the dependencies:
|
||
|
|
```npm
|
||
|
|
npm install
|
||
|
|
```
|
||
|
|
Run the following command to build and run (Dem mode)the project:
|
||
|
|
```npm
|
||
|
|
npm run dev
|
||
|
|
```
|
||
|
|
|
||
|
|
## TodoService
|
||
|
|
Before running the TodoService, ensure that you have Node.js, TypeScript (tsc), configured aws-cli and npm installed.
|
||
|
|
|
||
|
|
Navigate to the /todo-service directory.
|
||
|
|
|
||
|
|
Run the following command to install the dependencies:
|
||
|
|
```npm
|
||
|
|
npm install
|
||
|
|
```
|
||
|
|
Run the following command to build and run (Dem mode)the project:
|
||
|
|
```npm
|
||
|
|
npm run dev
|
||
|
|
```
|
||
|
|
|
||
|
|
## Requests
|
||
|
|
|
||
|
|
### Examples are located in request.http - can be run in VSCode with the REST Client extension.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|