Giter Club home page Giter Club logo

voyage-app-angular1's Introduction

Voyage Logo

Overview

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.

Quick start

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.

Table of Contents

Getting Started

Dependencies

What you need to run this app:

  • node, npm, and bower
  • Ensure you're running Node (v4.1.x+) and NPM (2.14.x+)

Installing

  • clone this repo
  • npm install to install npm dependencies
  • bower install to install bower dependencies

Generate constants

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.

Running 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.

Developing

Build files

  • single run: gulp build
  • build files and serve minified / 'built' files: gulp serve-dist

Testing

1. Unit Tests

  • single run: gulp test

voyage-app-angular1's People

Contributors

roblouie avatar

Stargazers

Josh Pierro avatar  avatar

Watchers

Steve Kickert avatar Jordan Koidahl avatar Jonathan Raymer avatar Stephen Hart avatar James Cloos avatar Jithendra Ganji avatar Nilesh Kulkarni avatar Josh Pierro avatar Sunil Bhujle avatar  avatar Phil Chabot avatar Kevin Wu avatar Deepak Raman avatar  avatar  avatar  avatar  avatar  avatar  avatar Srikanth avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.