Skip to content

Commit

Permalink
docs: add openapi spec docs in examples and improve the docs in servi…
Browse files Browse the repository at this point in the history
…ces (#215)
  • Loading branch information
sumit-tuteja authored Jun 4, 2021
1 parent 3fe4154 commit baec0f1
Show file tree
Hide file tree
Showing 62 changed files with 80,817 additions and 7,536 deletions.
9 changes: 5 additions & 4 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,11 @@ Our monorepo comes with few preconfigured
1. Open root folder of this repo in VS Code.
2. Install lerna globally `npm i -g lerna`
3. Run `lerna bootstrap`
4. Create .env files for all the micro service packages.
5. Run DB migrations using `lerna run db:migrate`.
6. Build all microservices in one go - `lerna run build`.
7. Run `lerna run start` to start all the micro services in one go.
4. Run `npm i`
5. Create .env files for all the micro service packages.
6. Run DB migrations using `lerna run db:migrate`.
7. Build all microservices in one go - `lerna run build`.
8. Run `lerna run start` to start all the micro services in one go.

## Building the project

Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# loopback4-microservice-catalog
# Sourceloop

[![LoopBack](https://github.com/strongloop/loopback-next/raw/master/docs/site/imgs/branding/Powered-by-LoopBack-Badge-(blue)[email protected])](http://loopback.io/)

[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

The `loopback4-microservice-catalog` is a collection of pre-built microservices that aim to reduce time to market for Enterprise projects. Large enterprises usually face a similar set of challenges when developing cloud native platforms as part of digital transformation efforts or the creation of new products. The services are implemented as [LoopBack Extensions](https://loopback.io/doc/en/lb4/Extending-LoopBack-4.html), allowing you to install them into existing LoopBack applications or use the [LoopBack Command-line interface](https://loopback.io/doc/en/lb4/Command-line-interface.html) to generate standalone services. Our recommended approach is to deploy these services as standalone micro-services in Docker.
The `Sourceloop` is a collection of pre-built microservices that aim to reduce time to market for Enterprise projects. Large enterprises usually face a similar set of challenges when developing cloud native platforms as part of digital transformation efforts or the creation of new products. The services are implemented as [LoopBack Extensions](https://loopback.io/doc/en/lb4/Extending-LoopBack-4.html), allowing you to install them into existing LoopBack applications or use the [LoopBack Command-line interface](https://loopback.io/doc/en/lb4/Command-line-interface.html) to generate standalone services. Our recommended approach is to deploy these services as standalone micro-services in Docker.

The current catalog consists of the following services:

Expand All @@ -28,7 +28,7 @@ This repository also contains a set of example projects in the [sandbox](sandbox

## Table of Contents

- [loopback4-microservice-catalog](#loopback4-microservice-catalog)
- [Sourceloop](#Sourceloop)
* [Table of Contents](#table-of-contents)
+ [Long Term Support](#long-term-support)
+ [Documentation](#documentation)
Expand Down Expand Up @@ -212,15 +212,15 @@ You can now run the example service with `npm start`.

### DataSources and Migrations

The `loopback4-microservice-catalog` can support any Loopback 4 [DataSource](https://loopback.io/doc/en/lb4/DataSource.html). While you may see existing `DataSource`s and [Database Migrations](https://loopback.io/doc/en/lb4/Database-migrations.html#overview), it is not mandatory to use them.
The `Sourceloop` can support any Loopback 4 [DataSource](https://loopback.io/doc/en/lb4/DataSource.html). While you may see existing `DataSource`s and [Database Migrations](https://loopback.io/doc/en/lb4/Database-migrations.html#overview), it is not mandatory to use them.

### Production Deployment

Inside of the `sandbox` folder, you will find example applications and Dockerfiles for each application. The `loopback4-microservice-catalog` is agnostic of the Docker deployment strategy. Deploy the services into the platform of your choice.
Inside of the `sandbox` folder, you will find example applications and Dockerfiles for each application. The `Sourceloop` is agnostic of the Docker deployment strategy. Deploy the services into the platform of your choice.

### Related Projects

The `loopback4-microservice-catalog` utilizes many extensions created by SourceFuse.
The `Sourceloop` utilizes many extensions created by SourceFuse.

* [sourcefuse/loopback4-ratelimiter: A rate limiting extension for loopback4 applications (github.com)](https://github.com/sourcefuse/loopback4-ratelimiter)
* [sourcefuse/loopback4-notifications: An extension for setting up various notification mechanisms in loopback4 application, vis-a-vis, Push notification, SMS notification, Email notification (github.com)](https://github.com/sourcefuse/loopback4-notifications)
Expand All @@ -234,7 +234,7 @@ The `loopback4-microservice-catalog` utilizes many extensions created by SourceF

### Feedback

If you've noticed a bug or have a question or have a feature request, [search the issue tracker]([Issues · sourcefuse/loopback4-microservice-catalog · GitHub](https://github.com/sourcefuse/loopback4-microservice-catalog/issues)) to see if someone else in the community has already created a ticket. If not, go ahead and [make one](https://github.com/sourcefuse/loopback4-microservice-catalog/issues/new/choose)! All feature requests are welcome. Implementation time may vary. Feel free to contribute the same, if you can. If you think this extension is useful, please [star](https://help.github.com/en/articles/about-stars) it. Appreciation really helps in keeping this project alive.
If you've noticed a bug or have a question or have a feature request, [search the issue tracker]([Issues · sourcefuse/loopback4-microservices-catalog · GitHub](https://github.com/sourcefuse/loopback4-microservice-catalog/issues)) to see if someone else in the community has already created a ticket. If not, go ahead and [make one](https://github.com/sourcefuse/loopback4-microservice-catalog/issues/new/choose)! All feature requests are welcome. Implementation time may vary. Feel free to contribute the same, if you can. If you think this extension is useful, please [star](https://help.github.com/en/articles/about-stars) it. Appreciation really helps in keeping this project alive.

### Contributing

Expand Down
4 changes: 4 additions & 0 deletions sandbox/audit-ms-example/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# auth-multitenant-example

[![LoopBack](https://github.com/strongloop/loopback-next/raw/master/docs/site/imgs/branding/Powered-by-LoopBack-Badge-(blue)[email protected])](http://loopback.io/)

#### API Details

Visit the [OpenAPI spec docs](./openapi.md)
Loading

0 comments on commit baec0f1

Please sign in to comment.