kingsleyeze/deep-framework

Full-stack JavaScript Framework for Cloud-Native Web Applications (feel free to call it Serverless)

DEEP Framework

DEEP Framework is a Full-Stack JavaScript 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 as Developer Guide and API Guide.

Learn hands-on how to build and deploy cloud-native web applications from this blog post and this tutorial video.

Getting Started

Step 1. Pre-requisites

• Create an Amazon Web Services account
• Configure AWS Command Line Interface
• Get Started - Installing Git
• JDK 8 and JRE 8 Installation Start Here
• Install nvm and use node v6.10+
• 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 running npm install deepify -g and make sure all npm and deepify commands are executed inside Git Bash.

Step 2. Install Microservice(s) Locally

deepify install github://MitocGroup/deep-microservices-helloworld ~/deep-microservices-helloworld

Path parameter in all deepify commands is optional and if not specified, assumes current working directory. Therefore you can skip ~/deep-microservices-helloworld by executing mkdir ~/deep-microservices-helloworld && cd ~/deep-microservices-helloworld before deepify install.

Step 3. Run Microservice(s) in Development

deepify server ~/deep-microservices-helloworld -o

When this step is finished, you can open in your browser the link http://localhost:8000 and enjoy the deep-microservices-helloworld running locally.

Step 4. Deploy Microservice(s) to Production

deepify deploy ~/deep-microservices-helloworld

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.

Step 5. Remove Microservice(s) from Production

deepify undeploy ~/deep-microservices-helloworld

Amazon CloudFront distribution takes up to 20 minutes to unprovision. That's why deepify command checks every 30 seconds if it's disabled and when successful, removes it from your account.

Developer Resources

Having questions related to deep-framework?

• Ask questions: https://stackoverflow.com/questions/tagged/deep-framework
• Chat with us: https://mitocgroup.slack.com/messages/general
• Send an email: [email protected]

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
• Releases: https://github.com/MitocGroup/deep-framework/releases
• Roadmap: https://github.com/MitocGroup/deep-framework/blob/master/ROADMAP.md

Looking for web applications that use (or are similar to) deep-framework?

• Hello World: https://hello.deep.mg | https://github.com/MitocGroup/deep-microservices-helloworld
• Todo App: https://todo.deep.mg | https://github.com/MitocGroup/deep-microservices-todomvc
• AdTechMedia: https://www.adtechmedia.io | https://github.com/AdTechMedia/adtechmedia-website

Sponsors

This repository is being sponsored by:

• Mitoc Group
• AdTechMedia

This code can be used under MIT license:

See LICENSE for more details.