TodoSystemMicroService-NodeJS/README.md

54 lines
1.2 KiB
Markdown
Raw Normal View History

2023-07-07 22:54:57 +00:00
# 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
2023-07-08 21:00:11 +00:00
```
2023-07-07 22:54:57 +00:00
## NotificationService
2023-07-08 21:00:11 +00:00
2023-07-07 22:54:57 +00:00
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:
2023-07-08 21:00:11 +00:00
2023-07-07 22:54:57 +00:00
```npm
npm install
```
2023-07-08 21:00:11 +00:00
2023-07-07 22:54:57 +00:00
Run the following command to build and run (Dem mode)the project:
2023-07-08 21:00:11 +00:00
2023-07-07 22:54:57 +00:00
```npm
npm run dev
```
## TodoService
2023-07-08 21:00:11 +00:00
Before running the TodoService, ensure that you have Node.js, TypeScript (tsc) and npm installed.
2023-07-07 22:54:57 +00:00
Navigate to the /todo-service directory.
Run the following command to install the dependencies:
2023-07-08 21:00:11 +00:00
2023-07-07 22:54:57 +00:00
```npm
npm install
```
2023-07-08 21:00:11 +00:00
2023-07-07 22:54:57 +00:00
Run the following command to build and run (Dem mode)the project:
2023-07-08 21:00:11 +00:00
2023-07-07 22:54:57 +00:00
```npm
npm run dev
```
## Requests
2023-07-08 21:00:11 +00:00
Examples are located in request.http - can be run in VSCode with the REST Client extension.