Skip to content

Commit 34feaf9

Browse files
Surbhi-sharma1yeshamavani
Surbhi-sharma1
and
yeshamavani
authored
docs(all-services): add arc branding and improve documentation (#2210)
* docs(all-services): add arc branding and improve documentation GH-1440 * docs(chat-service): add arc branding in chat service add arc branding in chat service GH-1440 * docs(chat-service): update readme update readme GH-1440 * docs(chat-service): update readme update readme GH-1440 --------- Co-authored-by: yeshamavani <[email protected]>
1 parent 8b066bb commit 34feaf9

File tree

4 files changed

+97
-21
lines changed

4 files changed

+97
-21
lines changed

‎services/authentication-service/LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) [2020-2024] [SourceFuse]
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎services/authentication-service/README.md‎

Lines changed: 27 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,24 @@
1-
# @sourceloop/authentication-service
2-
3-
[![LoopBack](<https://github.com/strongloop/loopback-next/raw/master/docs/site/imgs/branding/Powered-by-LoopBack-Badge-(blue)[email protected]>)](http://loopback.io/)
4-
5-
![npm](https://img.shields.io/npm/dm/@sourceloop/authentication-service)
6-
7-
![node-current (scoped)](https://img.shields.io/node/v/@sourceloop/authentication-service)
8-
9-
![npm (prod) dependency version (scoped)](https://img.shields.io/npm/dependency-version/@sourceloop/authentication-service/@loopback/core)
10-
11-
![check-code-coverage](https://img.shields.io/badge/code--coverage-75.01%25-yellow)
1+
<a style="position: relative; top: 10px;" href="https://sourcefuse.github.io/arc-docs/arc-api-docs" target="_blank"><img src="https://github.com/sourcefuse/loopback4-microservice-catalog/blob/master/docs/assets/logo-dark-bg.png?raw=true" alt="ARC By SourceFuse logo" title="ARC By SourceFuse" align="right" width="150" /></a>
2+
3+
# [@sourceloop/authentication-service](https://github.com/sourcefuse/loopback4-microservice-catalog/tree/master/services/authentication-service)
4+
5+
<p align="left">
6+
<a href="https://www.npmjs.org/package/@sourceloop/authentication-service">
7+
<img src="https://img.shields.io/npm/v/@sourceloop/authentication-service.svg" alt="npm version" />
8+
</a>
9+
<a href="https://github.com/sourcefuse/loopback4-microservice-catalog/graphs/contributors" target="_blank">
10+
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/sourcefuse/loopback4-microservice-catalog">
11+
</a>
12+
<a href="https://www.npmjs.com/@sourceloop/authentication-service" target="_blank">
13+
<img alt="sourceloop authentication-service downloads" src="https://img.shields.io/npm/dm/@sourceloop/authentication-service">
14+
</a>
15+
<a href="./LICENSE">
16+
<img src="https://img.shields.io/github/license/sourcefuse/loopback4-microservice-catalog" alt="License" />
17+
</a>
18+
<a href="https://loopback.io/" target="_blank">
19+
<img alt="Pb Loopback" src="https://img.shields.io/badge/Powered%20by-Loopback 4-brightgreen" />
20+
</a>
21+
</p>
1222

1323
## Overview
1424

@@ -182,6 +192,8 @@ npm i @sourceloop/authentication-service
182192
ADD client_type varchar(100) DEFAULT 'public';
183193
```
184194
195+
For a more elaborate implementation , see `/sandbox/auth-public-private-client`.
196+
185197
- **Authenticating JWT using RSA Encryption**
186198
187199
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:
@@ -524,3 +536,7 @@ Authorization: Bearer <token> where <token> is a JWT token signed using JWT issu
524536
#### API Details
525537

526538
Visit the [OpenAPI spec docs](./openapi.md)
539+
540+
## License
541+
542+
Sourceloop is [MIT licensed](./LICENSE).

‎services/chat-service/LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) [2020-2024] [SourceFuse]
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎services/chat-service/README.md‎

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,30 @@
1-
# chat-service
2-
3-
[![LoopBack](<https://github.com/strongloop/loopback-next/raw/master/docs/site/imgs/branding/Powered-by-LoopBack-Badge-(blue)[email protected]>)](http://loopback.io/)
4-
5-
![npm](https://img.shields.io/npm/dm/@sourceloop/chat-service)
6-
7-
![node-current (scoped)](https://img.shields.io/node/v/@sourceloop/chat-service)
8-
9-
![npm (prod) dependency version (scoped)](https://img.shields.io/npm/dependency-version/@sourceloop/chat-service/@loopback/core)
1+
<a style="position: relative; top: 10px;" href="https://sourcefuse.github.io/arc-docs/arc-api-docs" target="_blank"><img src="https://github.com/sourcefuse/loopback4-microservice-catalog/blob/master/docs/assets/logo-dark-bg.png?raw=true" alt="ARC By SourceFuse logo" title="ARC By SourceFuse" align="right" width="150" /></a>
2+
3+
# [@sourceloop/chat-service](https://github.com/sourcefuse/loopback4-microservice-catalog/tree/master/services/chat-service)
4+
5+
<p align="left">
6+
<a href="https://nodejs.org/en/" target="_blank">
7+
<img src="https://img.shields.io/node/v/@sourceloop/chat-service" alt="Node.js version (scoped)" />
8+
</a>
9+
<a href="https://github.com/sourcefuse/loopback4-microservice-catalog/graphs/contributors" target="_blank">
10+
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/sourcefuse/loopback4-microservice-catalog">
11+
</a>
12+
<a href="https://www.npmjs.com/@sourceloop/chat-service" target="_blank">
13+
<img alt="sourceloop chat-service downloads" src="https://img.shields.io/npm/dm/@sourceloop/chat-service">
14+
</a>
15+
<a href="./LICENSE">
16+
<img src="https://img.shields.io/github/license/sourcefuse/loopback4-microservice-catalog" alt="License" />
17+
</a>
18+
<a href="https://loopback.io/" target="_blank">
19+
<img alt="Pb Loopback" src="https://img.shields.io/badge/Powered%20by-Loopback 4-brightgreen" />
20+
</a>
21+
</p>
1022

1123
## Overview
1224

13-
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.
25+
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.
26+
27+
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.
1428

1529
### Installation
1630

@@ -176,3 +190,7 @@ Authorization: Bearer <token> where <token> is a JWT token signed using JWT issu
176190
## API Details
177191

178192
Visit the [OpenAPI spec docs](./openapi.md)
193+
194+
## License
195+
196+
Sourceloop is [MIT licensed](./LICENSE).

0 commit comments

Comments
 (0)