From 45c77f25db97fb729ffdc536a8adb7ed99f91b0e Mon Sep 17 00:00:00 2001 From: Surbhi Sharma Date: Thu, 14 Nov 2024 15:54:30 +0530 Subject: [PATCH 1/4] docs(all-services): add arc branding and improve documentation GH-1440 --- services/authentication-service/LICENSE | 21 ++++++++++++++ services/authentication-service/README.md | 34 +++++++++++++++-------- 2 files changed, 44 insertions(+), 11 deletions(-) create mode 100644 services/authentication-service/LICENSE diff --git a/services/authentication-service/LICENSE b/services/authentication-service/LICENSE new file mode 100644 index 0000000000..4e0b10e6d2 --- /dev/null +++ b/services/authentication-service/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) [2020-2024] [SourceFuse] + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/services/authentication-service/README.md b/services/authentication-service/README.md index 48cd02f1d2..b297e57ed3 100644 --- a/services/authentication-service/README.md +++ b/services/authentication-service/README.md @@ -1,14 +1,24 @@ -# @sourceloop/authentication-service - -[![LoopBack]()](http://loopback.io/) - -![npm](https://img.shields.io/npm/dm/@sourceloop/authentication-service) - -![node-current (scoped)](https://img.shields.io/node/v/@sourceloop/authentication-service) - -![npm (prod) dependency version (scoped)](https://img.shields.io/npm/dependency-version/@sourceloop/authentication-service/@loopback/core) - -![check-code-coverage](https://img.shields.io/badge/code--coverage-75.01%25-yellow) +ARC By SourceFuse logo + +# [@sourceloop/authentication-service](https://github.com/sourcefuse/loopback4-microservice-catalog/tree/master/services/authentication-service) + +

+ +npm version + + +GitHub contributors + + +sourceloop authentication-service downloads + + +License + + +Pb Loopback + +

## Overview @@ -182,6 +192,8 @@ npm i @sourceloop/authentication-service ADD client_type varchar(100) DEFAULT 'public'; ``` + For a more elaborate implementation , see `/sandbox/auth-public-private-client`. + - **Authenticating JWT using RSA Encryption** In order to authenticate JWT token using RSA encrytion, we need to provide JWT_PUBLIC_KEY and JWT_PRIVATE_KEY where the JWT_PUBLIC_KEY and JWT_PRIVATE_KEY are the paths to your public and private keys(.pem files).Steps to create Public key and private key are as follows: From c937cd2b628ae39b2a2667115cd1d9977ffbf5c2 Mon Sep 17 00:00:00 2001 From: Surbhi Sharma Date: Mon, 18 Nov 2024 11:13:08 +0530 Subject: [PATCH 2/4] docs(chat-service): add arc branding in chat service add arc branding in chat service GH-1440 --- services/chat-service/LICENSE | 21 +++++++++++++++++++++ services/chat-service/README.md | 30 +++++++++++++++++++++--------- 2 files changed, 42 insertions(+), 9 deletions(-) create mode 100644 services/chat-service/LICENSE diff --git a/services/chat-service/LICENSE b/services/chat-service/LICENSE new file mode 100644 index 0000000000..4e0b10e6d2 --- /dev/null +++ b/services/chat-service/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) [2020-2024] [SourceFuse] + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/services/chat-service/README.md b/services/chat-service/README.md index a1e8561754..0920159830 100644 --- a/services/chat-service/README.md +++ b/services/chat-service/README.md @@ -1,12 +1,24 @@ -# chat-service - -[![LoopBack]()](http://loopback.io/) - -![npm](https://img.shields.io/npm/dm/@sourceloop/chat-service) - -![node-current (scoped)](https://img.shields.io/node/v/@sourceloop/chat-service) - -![npm (prod) dependency version (scoped)](https://img.shields.io/npm/dependency-version/@sourceloop/chat-service/@loopback/core) +ARC By SourceFuse logo + +# [@sourceloop/chat-service](https://github.com/sourcefuse/loopback4-microservice-catalog/tree/master/services/chat-service) + +

+ + Node.js version (scoped) + + +GitHub contributors + + +sourceloop chat-service downloads + + +License + + +Pb Loopback + +

## Overview From 2dca49fd292c71805e94f21485700c1ae936459c Mon Sep 17 00:00:00 2001 From: Surbhi Sharma Date: Mon, 18 Nov 2024 15:29:27 +0530 Subject: [PATCH 3/4] docs(chat-service): update readme update readme GH-1440 --- services/authentication-service/README.md | 4 ++++ services/chat-service/README.md | 8 +++++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/services/authentication-service/README.md b/services/authentication-service/README.md index b297e57ed3..13fa2aa0aa 100644 --- a/services/authentication-service/README.md +++ b/services/authentication-service/README.md @@ -533,3 +533,7 @@ Authorization: Bearer where is a JWT token signed using JWT issu #### API Details Visit the [OpenAPI spec docs](./openapi.md) + +## License + +Sourceloop is [MIT licensed](./LICENSE). diff --git a/services/chat-service/README.md b/services/chat-service/README.md index 0920159830..177332c974 100644 --- a/services/chat-service/README.md +++ b/services/chat-service/README.md @@ -22,7 +22,9 @@ ## Overview -A microservice designed to facilitate real-time communication between users and user groups. It provides a scalable and modular solution for handling both individual and group chat functionalities. +A microservice designed to facilitate real-time communication between users and user groups. It provides a scalable and modular solution for handling both individual and group chat functionalities.This service supports Sequelize as the underlying ORM via the @loopback/sequelize extension, allowing for easy integration with relational databases. + +Additionally, it includes functionality for handling file attachments, allowing users to upload and download files as part of their chat interactions. The service ensures that only authenticated and authorized users can download attachments, providing secure access to files. It also tracks who downloads each attachment for auditing purposes. ### Installation @@ -185,3 +187,7 @@ Authorization: Bearer where is a JWT token signed using JWT issu ## API Details Visit the [OpenAPI spec docs](./openapi.md) + +## License + +Sourceloop is [MIT licensed](./LICENSE). From 8420cb00023ee0719894f768445d43165d62b533 Mon Sep 17 00:00:00 2001 From: Surbhi Sharma Date: Tue, 19 Nov 2024 16:11:22 +0530 Subject: [PATCH 4/4] docs(chat-service): update readme update readme GH-1440 --- services/authentication-service/README.md | 2 +- services/chat-service/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/services/authentication-service/README.md b/services/authentication-service/README.md index 13fa2aa0aa..66b311c6e0 100644 --- a/services/authentication-service/README.md +++ b/services/authentication-service/README.md @@ -9,7 +9,7 @@ GitHub contributors - + sourceloop authentication-service downloads diff --git a/services/chat-service/README.md b/services/chat-service/README.md index 177332c974..14c502f69d 100644 --- a/services/chat-service/README.md +++ b/services/chat-service/README.md @@ -9,7 +9,7 @@ GitHub contributors - + sourceloop chat-service downloads