Name: mean-starter
Owner: International Business Machines
Description: null
Created: 2018-04-14 04:02:26.0
Updated: 2018-05-03 20:36:39.0
Pushed: 2018-04-14 04:03:44.0
Homepage: null
Size: 31
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
This starter project provides the base elements needed to create an application using the MEAN stack (MongoDB, ExpressJS, an Angular front end and a Node backend).
If you have already installed the IBM Cloud Developer Tool (IDT), that's the place to start. It's an easy one command install; instructions are here: IDT Install Instructions
Note IDT build and runs the project using Docker containers. This is recommended for cloud native development. However, direct use of native tools (e.g. npm) is also supported. See the 'Using Native Tools' appendix at the end of this read me for further details.
The starter project supports the concept of dev mode and release mode. In dev mode, the starter app runs with dev dependencies installed and hot reload enabled for both the frontend and backend aspects of the app. Dev mode is intended for use during app development. Release mode exclude dev dependencies and runs the app without hot reload. Release mode is intended for running in production.
build project with command:
build --debug
This installs all dependencies, including dev dependencies.
run project test cases with command:
test
This runs the project's unit tests with mocha.
run the app in dev mode with command:
shell run-dev
This runs the app in dev mode. A development web server runs on port 3000 and the app itself runs on port 3100. The web server and app will automatically reload if changes are made to the source.
run the app in interactive debug mode with command:
debug
This runs the app in interactive debug mode. The app listens on port 5858 for the debug client to attach to it, and on port 3000 for app requests.
build project
build
Builds project using 'Dockerfile-tools'. Effectively equivalent to 'idt build –debug'.
run project
run
Runs project using release image (builds on fly using 'Dockerfile'). Hot reload is not available in the release image.
Whether you run in dev mode or release mode, you have the same default URLs available to you:
These projects are designed for deployment through the IDT CLI to the IBM Cloud, to either Kubernetes (public or private cloud) or Cloud Foundry (public cloud only).
To deploy app:
```
idt deploy [--target container]
```
Deploys app to Cloud Foundry by default or to Kubernetes (on IBM Cloud) if you specify the –target option.
NOTE: If you choose the ?IBM DevOps, using Cloud Foundry buildpacks? options when you create your project, there is no need to manually deploy the app to Cloud Foundry.
Deployment to other environments is possible using native commands. See the 'Native Tools Appendix' below for further details.
This section specifies how to use native commands to do development on this project outside of containers and without the IDT CLI.
Note, when running the project with native commands in either dev or release mode, you must provide your own mongo server. See Mongo section below for details.
build project with command:
install
This installs all dependencies, including dev dependencies.
run project test cases with command:
test
This runs the project's unit tests with mocha.
run the app in dev mode with command:
run dev
This runs the app in dev mode. A development web server runs on port 3000 and the app itself runs on port 3100. These web server and app will automatically reload if changes are made to the source.
run the app in interactive debug mode with command:
run debug
This runs the app interactive debug mode. The app listens on port 5858 for the debug client to attach to it, and on port 3000 for app requests.
build project
install --only=dev; npm run build; npm prune --production
Upon completion, webpack has been run and dev dependencies removed.
run project
start
Runs app in release mode. App listens on port 3000. Hot reload is not available in this mode.
NOTE: Since this project connects to a running Mongo server, you must provide one when working with native commands. Install instructions are here: https://docs.mongodb.com/manual/administration/install-community/
The project's access to Mongo is controlled through these environment variables with their default values shown:
MONGO_URL='localhost:27017';
MONGO_USER='';
MONGO_PASS='';
MONGO_DB_NAME='';
To make configuration changes, edit the “server/routers/mongo.js” file.
You can install and run your app on bare metal or virtual machine environments conventionally:
elete node_modules
reate app archive (e.g. zip up directory)
opy to target machine
nwind (e.g. unzip archive)
pm install
pm start
You can deploy to Cloud Foundry using:
ush
You can deploy to Kubernetes using:
ocker build -p 3000:3000 --name <name> .
ublish image to target registry (e.g. dockerhub)
elm install chart/<project name>
For Helm deployment, make sure to review variables.yaml in your project's chart to ensure suitable values for your deployment, including your image name and location.
Once you have deployed your application successfully into your Kubernetes cluster. You can test your application by retrieving the IP address of your worker nodes using the Bluemix CLI. Make sure you that you are logged into your cluster.
cs workers <clusterName>
bectl get services
Note: In the column labeled ports you will see two numbers and the protocol (TCP/UDP) The port number on the left is the internal / guest port from the container. The port number on the right is the external port that you will use to access your application.