Skip to content

Commit 2af1966

Browse files
committed
Cleanup README
1 parent 33a4da8 commit 2af1966

1 file changed

Lines changed: 8 additions & 18 deletions

File tree

README.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,30 +11,30 @@
1111
[![Coverage][sonarcloud-coverage-badge]][sonarcloud-url]
1212
[![Duplicated Lines (%)][sonarcloud-duplicated-badge]][sonarcloud-url]
1313

14+
## Introduction
15+
1416
Example of encrypting/decrypting data thru an API using node.js.
1517

1618
The idea with this example is to test how to store encrypted data under a datastore (ex. MongoDB) and keep control of your data by providing the encryption key for each call.
1719

18-
This project doesn't cover encryption in transit (SSL) and not meant to be used in production.
19-
20-
## Requirements
21-
22-
- API storing endpoint: encrypt data with the provided key and store it into a MongoDB collection with AES-256-CBC encryption
23-
- API retrieval endpoint: decrypt data with the provided key and return the data
20+
> This project doesn't cover encryption in transit (SSL) and not meant to be used in production.
2421
2522
## Features
2623

24+
- API storing endpoint that encrypts data with the provided key and store it into a MongoDB collection (AES-256-CBC encryption)
25+
- API retrieval endpoint that decrypts data with the provided key and return the data
2726
- AES-256-CBC encryption that uses a random Initialization Vector (IV)
2827
- IV stored with the encrypted data (separated by a `:` character)
2928
- Logs with correlation ID
3029
- MongoDB as data store (using Mongoose)
31-
- Swagger support for API specifications/documentation
30+
- Swagger support for API specifications/documentation (WIP)
3231
- Health check endpoint to check if the app is still alive
3332
- Dockerfile to generate the Docker image
3433
- Docker Compose file to launch the API and MongoDB official Docker images
3534
- Build, test and deploy to Docker Hub with Travis CI
3635
- SonarQube code quality check (SonarCloud)
3736
- Unit tests and functional tests
37+
- Postman collection and environment
3838

3939
## Run locally
4040

@@ -78,7 +78,7 @@ npm run test:all
7878

7979
### Docker Compose
8080

81-
Be sure that you are not running MongoDB + another node.js app that uses the `3000` port
81+
> Be sure that you are not running MongoDB + another node.js app that uses the `3000` port
8282
8383
```bash
8484
docker-compose up
@@ -202,16 +202,6 @@ This will return an array of results:
202202

203203
``` json
204204
[
205-
{
206-
"id": "test-01",
207-
"value": {
208-
"first_name": "firstname",
209-
"last_name": "lastname",
210-
"email": "email@email.com",
211-
"password": "app123",
212-
"password_confirmation": "app123"
213-
}
214-
},
215205
{
216206
"id": "test-01-01",
217207
"value": {

0 commit comments

Comments
 (0)