Package Exports
- deep-resource
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (deep-resource) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
DEEP Resource Library (deep-resource)
DEEP Framework is a full-stack web framework for building cloud-native web applications.
This framework is a core component of a larger ecosystem, called Digital Enterprise End-to-end Platform.
Using DEEP Framework, developers get out-of-the-box:
- streamlined "production-like" development environment
- enterprise-level platform using microservices architecture
- virtually infinite scalability with zero devops (aka serverless computing)
- abstracted use of web services from cloud providers (e.g. AWS, GCP, etc.)
Amazon Web Services is the only supported cloud provider at the moment. Help needed to add support for Google Cloud Platform, Microsoft Azure, and others.
Documentation is available at docs.deep.mg.
Getting Started
Install DEEP CLI, also known as deepify:
npm install deepify -g
If you want to use
deepify
on Windows, please follow the steps from Windows Configuration before runningnpm install deepify -g
and make sure allnpm
anddeepify
commands are executed inside Git Bash.
Using deepify, dump locally the helloworld example:
deepify helloworld ~/deep-hello-world
This command is equivalent to the generic command used globally:
deepify install github://MitocGroup/deep-microservices-helloworld ~/deep-hello-world
Next, run locally the helloworld project:
deepify server ~/deep-hello-world -o
When this step is finished, you can open in your browser the link http://localhost:8000 and enjoy the helloworld project running locally.
Finally, deploy the helloworld to cloud provider:
deepify deploy ~/deep-hello-world
Amazon CloudFront distribution takes up to 20 minutes to provision, therefore don’t worry if it returns an HTTP error in the first couple of minutes.
What is DEEP Framework?
DEEP Framework is a nodejs package that is published on npmjs: https://www.npmjs.com/package/deep-framework.
If you are new to node and npm, check out the tutorial how to install nodejs.
In fact, this framework is a collection of nodejs packages, also identifiable as abstracted libraries:
DEEP Framework | API Docs | Abstracted Web Service(s) |
---|---|---|
deep-asset | Assets Management Library | Amazon S3 |
deep-cache | Cache Management Library | Amazon ElastiCache |
deep-core | Core Management Library | - |
deep-db | Database Management Library | Amazon DynamoDB, Amazon SQS |
deep-di | Dependency Injection Management Library | - |
deep-event | Events Management Library | Amazon Kinesis |
deep-fs | File System Management Library | Amazon S3 |
deep-kernel | Kernel Management Library | - |
deep-log | Logs Management Library | Amazon CloudWatch Logs |
deep-notification | Notifications Management Library | Amazon SNS |
deep-resource | Resouces Management Library | AWS Lambda, Amazon API Gateway |
deep-security | Security Management Library | AWS IAM, Amazon Cognito |
deep-validation | Validation Management Library | - |
Who is using DEEP Framework?
There are couple examples / web applications that are built on top of DEEP Framework:
DEEP Hello World
DEEP Hello World is a web app
that show cases a full stack example of using DEEP Microservices in the context of Platform-as-a-Service.
Developers can either fork this repository or npm install deepify -g
and run in the command line
deepify helloworld ~/deep-hello-world
.
DEEP Todo App
DEEP Todo App is a web app inspired from AngularJS TodoMVC Example. It reuses AngularJS module and integrates using DEEP Framework to streamline development and deployment using cloud-based web services.
DEEP Marketplace
DEEP Marketplace is Software-as-a-Service for enterprise software, built on top of DEEP, that empowers customers to choose functionality from listed microservices and deploy them together as an web app into their own AWS accounts with just few clicks; as well as empowers developers to create and publish their microservices and monetize them in similar approach to Apple's App Store.
Developer Resources
Building an application with DEEP Framework?
- Ask questions: https://stackoverflow.com/questions/tagged/deep-framework
- Chat with us: https://gitter.im/MitocGroup/deep-framework
- Send messages: feedback@deep.mg
Interested in contributing to DEEP Framework?
- Contributing: https://github.com/MitocGroup/deep-framework/blob/master/CONTRIBUTING.md
- Issue tracker: https://github.com/MitocGroup/deep-framework/issues
- Roadmap: https://github.com/MitocGroup/deep-framework/blob/master/ROADMAP.md
- Changelog: https://github.com/MitocGroup/deep-framework/blob/master/CHANGELOG.md
Sponsors
This repository is being sponsored by:
The code can be used under the MIT license:
See LICENSE for more details.