Skip to content

Commit 2236218

Browse files
committed
Add new TODO to support #TravisAlumns :)
1 parent 2af1966 commit 2236218

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ The idea with this example is to test how to store encrypted data under a datast
2121
2222
## Features
2323

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
24+
- API storing endpoint that encrypts data with the provided key and stores it into a MongoDB collection (AES-256-CBC encryption)
25+
- API retrieval endpoint that decrypts data with the provided key and returns the data
2626
- AES-256-CBC encryption that uses a random Initialization Vector (IV)
2727
- IV stored with the encrypted data (separated by a `:` character)
2828
- Logs with correlation ID
29-
- MongoDB as data store (using Mongoose)
29+
- MongoDB as a data store (using Mongoose)
3030
- Swagger support for API specifications/documentation (WIP)
3131
- Health check endpoint to check if the app is still alive
3232
- Dockerfile to generate the Docker image
@@ -100,7 +100,7 @@ Download the [Postman Environment][postman-environment]
100100

101101
## Documentation / Specifications
102102

103-
You can access to the documentation (Swagger) here:
103+
You can access the documentation (Swagger) here:
104104

105105
[http://localhost:3000/swagger][swagger]
106106

@@ -153,7 +153,7 @@ Note that the IV is in the first part fo the encrypted data (`42d0f6eb0810caaaaf
153153

154154
#### Get a specific ID
155155

156-
You can do a search by ID (`test-01` in this example):
156+
You can search by ID (`test-01` in this example):
157157

158158
``` bash
159159
curl -X POST \
@@ -185,7 +185,7 @@ This will return an array with a unique result:
185185

186186
#### Get ID with a wildcard `*`
187187

188-
You can also do a search by using a wildcard `*` at the end of your ID (`test-01-*` in this example):
188+
You can also search by using a wildcard `*` at the end of your ID (`test-01-*` in this example):
189189

190190
``` bash
191191
curl -X POST \
@@ -237,9 +237,10 @@ This will return an array of results:
237237

238238
## TODO
239239

240-
- Return an empty array if bad encryption key instead of error
240+
- Return an empty array if wrong encryption key instead of error
241241
- Swagger detailed schema
242242
- PM2 support under the Docker container (to restart the app in case of crash)
243+
- Move from Travis-CI to CircleCI by support to the [#TravisAlumns][travis-alumns]
243244

244245
[swagger]: http://localhost:3000/swagger
245246
[allkeysgenerator]: https://www.allkeysgenerator.com/Random/Security-Encryption-Key-Generator.aspx
@@ -258,4 +259,5 @@ This will return an array of results:
258259
[sonarcloud-bugs-badge]: https://sonarcloud.io/api/project_badges/measure?project=timoa_nodejs-encryption-api-example&metric=bugs
259260
[sonarcloud-codesmells-badge]: https://sonarcloud.io/api/project_badges/measure?project=timoa_nodejs-encryption-api-example&metric=code_smells
260261
[sonarcloud-coverage-badge]: https://sonarcloud.io/api/project_badges/measure?project=timoa_nodejs-encryption-api-example&metric=coverage
261-
[sonarcloud-duplicated-badge]: https://sonarcloud.io/api/project_badges/measure?project=timoa_nodejs-encryption-api-example&metric=duplicated_lines_density
262+
[sonarcloud-duplicated-badge]: https://sonarcloud.io/api/project_badges/measure?project=timoa_nodejs-encryption-api-example&metric=duplicated_lines_density
263+
[travis-alumns]: https://twitter.com/ReinH/status/1098663375985229825

0 commit comments

Comments
 (0)