README

CAP Generator

Connected App Platorm Generator (CAP Generator)

CAP is an open-source suite of technologies for rapidly creating web and mobile applications that synchronize data with Salesforce and other systems. The CAP SDK (Software Development Kit) gives users the tools needed to quickly generate applications that can be fully customized.

Why CAP? Creating external connected applications to CRMs, ERPs and other external systems is involved and time consuming to build. CAP quickly generates the initial setup and creation of complex components like authorization, files and synchronization through an easy to use CAP CLI (Command Line Interface).

Previous requirements

First, install Yeoman (we assume you have pre-installed node.js).

npm install -g yo

You must also have Angular/CLI to build web applications.

npm i -g @angular/cli

Depending on Operating system you must have installed a package manager.

MacOS or Linux install Brew
Windows install Chocolatey

Note: To be able to use jq on Windows we recommend you check it the Unix tool on the Adjusting your path environment section.

Installation

Install generator-cap

npm install -g generator-cap

Update generator-cap:

npm update -g generator-cap

Usage

To generate a new project using CAP just run:

yo cap

It will prompt you a series of question regarding to your project

     _-----_     ╭──────────────────────────╮
    |       |    │       CAP Generator      │
    |--(o)--|    │    Build amazing apps    │
   `---------´   │     faster and better    │
    ( _´U`_ )    ╰──────────────────────────╯
    /___A___\   /
     |  ~  |     
   __'.___.'__   
 ´   `  |° ´ Y ` 

? What's the name of your application? front-end

? Select the Angular version you have installed (Use arrow keys)
❯ Angular 8 
  Angular 9 
  
? Choose an authentication service: Firebase
  Auth0 
❯ Firebase

? Set your ApiKey:  
? Set your Auth Domain:  
? Set your data base URL:  
? Set your Project ID:  
? Set your storage bucket:  
? Set your message sender ID:  
? Set your app ID:  
? Set your measurement ID: 

❯◯ CAP-Storage-Amazon-Web-Services
 ◯ CAP-Server-Side-Rendering
 ◯ CAP-SalesForce-Live-Chat
 ◯ CAP-Angular-Contentful
 
? Do you want your app to work like PWA (Progressive Web Application)? Yes
? Do you want to deploy your application in Heroku? Yes
? Do you want to use a synchronization/API service? Yes

? Heroku email 
? Heroku password [hidden]

Note In the question Do you want to deploy your application in Heroku? you must have a heroku account created and if it is possible to install Heroku/CLI. Contact us at sales@softwareallies.com for more information or auxiliary for better performance.

Note: in the last question ? Do you want to use a synchronization/API service? you must have a partnership in SalesForce so that you can synchronize your data to a database in conjunction with HerokuConnect. Contact us at sales@softwareallies.com for more information or auxiliary for better performance.

Subgenerators

This generator automatically includes the sub generators based on the user answers. For more detail about how to use each module we recommend go through their documentation

Module	Description
CAP STORAGE AWS	This module implements a connection with the Amazon Web Service server to upload files, images and videos to the provided account.
CAP AUTHENTICATION	This module implements a complete user authentication section for web application security (available for Auth0 and Firebase services)
CAP LIVE CHAT	This module implements a live chat service from the SalesForce service platform
CAP SF CORE	This module creates together with Heroku Cloud a back-end application with database and synchronization to a SalesForce company for data management. and also creates a CRUD to manipulate the data from the web application
CAP SSR	This module adds a functionality to your SPA application so that it shows the source code to the google crawlers for a better search of your app within the google servers
CAP PWA	This module implements a modality of your SPA application so that in some browsers you get direct access so that I take it as a native application of your computer or cell phone

generator-cap

Usage no npm install needed!