-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #12 from The-Standard-Organization/users/glhays/do…
…cumentation-readme-init DOCUMENTATION: Init Readme Setup
- Loading branch information
Showing
14 changed files
with
270 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,84 @@ | ||
| # STX.SPAL.Core | ||
|  | ||
|
|
||
| # STX.SPAL.Core | ||
|
|
||
| [](https://github.com/The-Standard-Organization/STX.SPAL.Core/actions/workflows/build.yml) | ||
| [](https://www.nuget.org/packages/STX.SPAL.Core) | ||
| [](https://www.nuget.org/packages/STX.SPAL.Core) | ||
| [](https://github.com/hassanhabib/The-Standard) | ||
| [](https://github.com/hassanhabib/The-Standard) | ||
| [](https://discord.gg/vdPZ7hS52X) | ||
|
|
||
| ## Introduction | ||
| This is the Core library for Standardized Provider Abstraction Libraries (SPAL) | ||
|
|
||
| SPAL is a concept to provide a standardized way to interact with different providers, such as brokers, and other services. | ||
|
|
||
| The SPAL.Core library provides the basic building blocks for creating SPAL libraries. | ||
|
|
||
|  | ||
|
|
||
| SPAL.Core should provide the following features: | ||
| >`Extensibility` - Standardized provider abstraction libraries must be extensible to support more external providers. | ||
| > | ||
| >`Configurability` - For Standardized libraries to be usable with several providers, it must allow engineers to configure them to target a particular provider, local or remote. | ||
| > | ||
| >`Distributability` - Abstraction libraries must allow several engineers to publish their extensions of the library. The library does not need to have implementations of all providers in one binary. Instead, these libraries must provide an interface or a contract that all other extensions must implement to support a specific provider. | ||
| > | ||
| >`External Mockability (Cloud-Foreign)` - Standardized provider libraries must allow communications with mocked local phantom APIs. | ||
|
|
||
| #### For further information, please refer to this section of the [The-Standard](https://github.com/hassanhabib/The-Standard/blob/master/1.%20Brokers/1.8%20Broker%20Provider%20Abstraction.md) | ||
|
|
||
| ### Engineering Architecture(InProgress) | ||
|
|
||
|  | ||
|
|
||
| ## Standard-Compliance | ||
| This library was built according to The Standard. The library follows engineering principles, patterns and tooling as recommended by The Standard. | ||
|
|
||
| This library is also a community effort which involves many hours of pair-programming, test-driven development and in-depth exploration, research, and design discussions. | ||
|
|
||
| ## Standard-Promise | ||
| The most important fulfillment aspect in a Standard complaint system is aimed towards contributing to people, its evolution, and principles. | ||
| An organization that systematically honors an environment of learning, training, and sharing knowledge is an organization that learns from the past, makes calculated risks for the future, | ||
| and brings everyone within it up to speed on the current state of things as honestly, rapidly, and efficiently as possible. | ||
|
|
||
| We believe that everyone has the right to privacy, and will never do anything that could violate that right. | ||
| We are committed to writing ethical and responsible software, and will always strive to use our skills, coding, and systems for the good. | ||
| We believe that these beliefs will help to ensure that our software(s) are safe and secure and that it will never be used to harm or collect personal data for malicious purposes. | ||
|
|
||
| The Standard Community as a promise to you is in upholding these values. | ||
|
|
||
| ## Contact Information | ||
|
|
||
| If you have any suggestions, comments or questions, please feel free to contact me on: | ||
|
|
||
| >[Twitter](https://twitter.com/hassanrezkhabib) | ||
| > | ||
| >[LinkedIn](https://www.linkedin.com/in/hassanrezkhabib/) | ||
| > | ||
| >[E-Mail](mailto:[email protected]) | ||
| ### Past Sessions | ||
|
|
||
| >Youtube | ||
| > | ||
| >[SPAL In Action](https://www.youtube.com/watch?v=gCDo24dJ5Fg) | ||
| > | ||
| >[Standard Provider Abstraction Libraries](https://www.youtube.com/watch?v=JEb0BA8CgFk) | ||
| > | ||
| >[Standard Provider Abstraction Libraries Part 2](https://www.youtube.com/watch?v=gvoskMQRqHU) | ||
| > | ||
| >[Standard Provider Abstraction Libraries Part 3](https://www.youtube.com/watch?v=98_9I2hpaKA&t=623s) | ||
| > | ||
| ### Important Notice | ||
| A special thanks to all the community members, and the following dedicated engineers for their hard work and dedication to the project. | ||
| >Mr. Hassan Habib | ||
| > | ||
| >Mr. Christo du Toit | ||
| > | ||
| >Mr. Raul LBoullosa | ||
| > | ||
| >Mr. Gregory Hays |
Oops, something went wrong.