Skip to content
This repository has been archived by the owner on Nov 23, 2020. It is now read-only.

Latest commit

 

History

History
66 lines (43 loc) · 3.3 KB

README.md

File metadata and controls

66 lines (43 loc) · 3.3 KB
Raw

Angular2-Stamplay-Starter

This project is a starter kit for developing an Angular 2 application and using Stamplay as a backend-as-a-service. The styling is provided by Material Design for Bootstrap.

This project was generated with angular-cli version 1.0.0-beta.17.

Installation

Install angular-cli with npm install -g angular-cli

You may need to install Typescript 2.0 if you haven't done this before npm install -g typescript

In order to use this project for your Stamplay website, install the Stamplay CLI: npm install -g stamplay-cli

If you don't have a website on Stamplay yet, create a free one on Stamplay.com

Change stamplay.json with your application id and api key that you'll find in the Stamplay website editor.

Set Stamplay.init("#YOUR-APP-ID"); in index.html with your Stamplay app id.

Run npm install to install the packages.

Run locally

Now you can start your application locally in two ways:

  1. ng serve from the angular-cli, which includes Live Reload. You must set your Stamplay app to accept CORS from your localhost (you can add "localhost:4200", as this is the port of the NG Live Dev Server) otherwise the Stamplay AJAX calls will fail.

  2. ng build to build the project and populate the dist folder, and then start the local server with stamplay start. This does not require to set the CORS and it is officially supported by the Stamplay platform, but you lose the LiveReload in dev.

Build and deploy

Use ng build -prod to kick off the production build process supported by angular-cli (which uses Webpack). This includes bundling and minification

You can also use the experimental ng build -prod --aot to build with Ahead-of-time compilation (which drastically reduces the application size).

The starter kit application size when built with --aot flag and delivered gzipped by the Stamplay hosting is 300kb.

Ultimately, use stamplay deploy to deploy your application (dist folder) and access it at https://YOUR-APP-ID.stamplayapp.com/

Stylying and 3rd-party libraries

The .css and .js dependencies can be inserted in angular-cli.json which currently includes:

"styles": [
        "../fonts/roboto.css",
        "../fonts/material-icons.css",
        "../node_modules/bootstrap/dist/css/bootstrap.min.css",
        "../node_modules/bootstrap-material-design/dist/css/bootstrap-material-design.min.css",
        "../node_modules/bootstrap-material-design/dist/css/ripples.min.css",
        "../node_modules/snackbarjs/dist/snackbar.min.css",      
        "styles.css"
      ],
"scripts": [
        "../node_modules/jquery/dist/jquery.min.js",
        "../node_modules/bootstrap/dist/js/bootstrap.min.js",
        "../node_modules/bootstrap-material-design/dist/js/material.min.js",
        "../node_modules/bootstrap-material-design/dist/js/ripples.min.js",
        "../node_modules/snackbarjs/dist/snackbar.min.js",
        "../node_modules/stamplay-sdk/dist/stamplay.min.js"
      ]

You can change the styling and provide your own Bootstrap theme (or any other css styling) by changing these css dependencies.

A live demo of the starter kit can be found at https://angular2-starter.stamplayapp.com/