A Google AngularJS v1.5 app that implements the fundamental features found in most business applications.
Intended Audiences:
- Businesses that wish to get their app out to market faster by "buying off the shelf" and extending
- Businesses that want to avoid the high risk of failure when rewriting or building a new app
- Development teams that want to leap forward in their technology stacks by leveraging an existing platform they can extend
- Development teams that want to follow and adopt a standard of development and best practices
- Developers that wish to learn new technology by reading good documentation and extending code that tightly follows the reference documentation.
Development Core Tenants
- Keep it simple
- Build for the "now". Don't build features for a future that is unclear
- Follow defacto standards & best practices of the tech stacks chosen
- Memorialize team decisions in Markdown (.md) files and store in the repo for future developers (ie this doc)
App Features
- User Login w/ Password Recovery
- User Account Management
- User Admin Console
- User Settings
- Alerts & Notifications
- Responsive UI for Desktop, Tablet, Mobile
- Integrates with Launchpad API for all data
Technology Stack
- Reference AngularJS 1.5 implementation
- Bootstrap v3 for responsive UI
- Angular Material components
- SASS
- Gulp + Bower build scripting
- JSLint enforcement of Javascript best practices
NOTE: If you are extending this codebase to build a new app, then replace this section with a detailed overview of the new app. Include as much or as little detail as necessary to convey to the developers what this project is about. Often times less is more.
Clone/Download the repo from git
# clone repo
$ git clone https://github.com/lssinc/voyage-app-angular1.git voyage-angularjs
# change directory to your app
$ cd voyage-angularjs
# install development dependencies with npm
$ npm install
# install ui dependencies with bower
$ bower install
# start the server
$ gulp serve
The app will open in your browser.
What you need to run this app:
node
,npm
, andbower
- Ensure you're running Node (
v4.1.x
+) and NPM (2.14.x
+)
clone
this reponpm install
to install npm dependenciesbower install
to install bower dependencies
Voyage relies on certain constants that may change based on project or environment, things like the api url or the client id for oauth. These constants are configured in environment-constants/environment-constants.json.
To generate the actual Angular constants from this config, run gulp generate-constants
. You're now ready to run the app.
After you have installed all dependencies you can now run the app with:
gulp serve
It will start a local server using browsersync which will watch and reload for you. The port will be displayed to you as http://localhost:3000
.
- single run:
gulp build
- build files and serve minified / 'built' files:
gulp serve-dist
- single run:
gulp test