Skip to content

Commit dc40c18

Browse files
committed
Update the readme
1 parent 406a970 commit dc40c18

1 file changed

Lines changed: 35 additions & 35 deletions

File tree

README.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,37 @@ This project is a demonstration of a complete Continuous Integration and Continu
44

55
## Features
66

7-
* **Continuous Integration (CI):**
8-
* Automated testing on multiple Node.js versions.
9-
* Code linting and static analysis to enforce code quality.
10-
* Vulnerability scanning to identify security risks.
11-
* Test coverage reports to measure code testability.
12-
* **Continuous Deployment (CD):**
13-
* Automated deployment to staging and production environments.
14-
* Docker containerization for consistent and portable deployments.
15-
* Health checks to ensure application availability.
16-
* **Node.js Application:**
17-
* A simple Express.js application with a few API endpoints.
18-
* Unit and integration tests using Jest and Supertest.
7+
- **Continuous Integration (CI):**
8+
- Automated testing on multiple Node.js versions.
9+
- Code linting and static analysis to enforce code quality.
10+
- Vulnerability scanning to identify security risks.
11+
- Test coverage reports to measure code testability.
12+
- **Continuous Deployment (CD):**
13+
- Automated deployment to staging and production environments.
14+
- Docker containerization for consistent and portable deployments.
15+
- Health checks to ensure application availability.
16+
- **Node.js Application:**
17+
- A simple Express.js application with a few API endpoints.
18+
- Unit and integration tests using Jest and Supertest.
1919

2020
## Technologies Used
2121

22-
* **Application:** Node.js, Express.js
23-
* **Testing:** Jest, Supertest
24-
* **CI/CD:** GitHub Actions
25-
* **Containerization:** Docker
26-
* **Code Quality:** ESLint
27-
* **Security:** Trivy
22+
- **Application:** Node.js, Express.js
23+
- **Testing:** Jest, Supertest
24+
- **CI/CD:** GitHub Actions
25+
- **Containerization:** Docker
26+
- **Code Quality:** ESLint
27+
- **Security:** Trivy
2828

2929
## Getting Started
3030

3131
To get a local copy up and running, follow these simple steps.
3232

3333
### Prerequisites
3434

35-
* Node.js (v18.x or later)
36-
* npm
37-
* Docker
35+
- Node.js (v18.x or later)
36+
- npm
37+
- Docker
3838

3939
### Installation
4040

@@ -73,23 +73,23 @@ graph TD
7373
I --> J{Notify};
7474
```
7575

76-
* **Test:** Runs unit tests on multiple Node.js versions.
77-
* **Code Quality:** Performs static analysis using ESLint.
78-
* **Security Scan:** Scans for vulnerabilities using Trivy.
79-
* **Build:** Builds the Docker image and pushes it to the container registry.
80-
* **Deploy to Staging:** Deploys the application to a staging environment.
81-
* **Integration Tests:** Runs integration tests against the staging environment.
82-
* **Deploy to Production:** Deploys the application to the production environment.
83-
* **Smoke Tests:** Runs smoke tests against the production environment.
84-
* **Notify:** Sends a notification about the deployment status.
76+
- **Test:** Runs unit tests on multiple Node.js versions.
77+
- **Code Quality:** Performs static analysis using ESLint.
78+
- **Security Scan:** Scans for vulnerabilities using Trivy.
79+
- **Build:** Builds the Docker image and pushes it to the container registry.
80+
- **Deploy to Staging:** Deploys the application to a staging environment.
81+
- **Integration Tests:** Runs integration tests against the staging environment.
82+
- **Deploy to Production:** Deploys the application to the production environment.
83+
- **Smoke Tests:** Runs smoke tests against the production environment.
84+
- **Notify:** Sends a notification about the deployment status.
8585

8686
## API Endpoints
8787

88-
| Method | Endpoint | Description |
89-
| ------ | ------------ | ---------------------------- |
90-
| GET | `/` | Returns a welcome message. |
88+
| Method | Endpoint | Description |
89+
| ------ | ------------ | ------------------------------------------ |
90+
| GET | `/` | Returns a welcome message. |
9191
| POST | `/calculate` | Calculates the sum of an array of numbers. |
92-
| GET | `/health` | Returns the application status. |
92+
| GET | `/health` | Returns the application status. |
9393

9494
### POST /calculate
9595

@@ -124,4 +124,4 @@ graph TD
124124
└── tests/
125125
├── app.test.js
126126
└── utils.test.js
127-
```
127+
```

0 commit comments

Comments
 (0)