Skip to content

AmmoCan/seedularjs

Repository files navigation

SeedularJS - A Seed for AngularJS App Projects

This seed allows you to easily start an AngularJS v1.6.x web app project.

It's built off the Angular 1 sub-generator of the Yeoman Fountain generator for webapps.

It uses Gulp 4 as a task manager.

It compiles, minifies, concatenates, and injects all the needed files.

The SeedularJS Layers

Below is the list of layers and their respective components you'll find inside SeedularJS:

Web Tooling Layer

Gulp ESLint BrowserSync Karma

Module Management Layer

Bower

JS Preprocessor Layer

JavaScript

CSS Preprocessor Layer

Sass

CSS Framework Layer

Foundation for Sites Font Awesome

Getting Started

To get started you can simply clone the seedularjs repository and install its dependencies:

Requirements

SeedularJS is to be used with Git, Node >= 7.10.0, NPM >= 4.6.1, and Gulp CLI >= 1.3.0. You can check your version numbers with the following command:

git --version && node --version && npm --version && gulp --version

Clone seedularjs

Clone the seedularjs repository using git:

git clone https://github.com/AmmoCan/seedularjs.git
cd seedularjs

If you just want to start a new project without the seedularjs commit history then you can do:

git clone --depth=1 https://github.com/AmmoCan/seedularjs.git <your-project-name>

The depth=1 tells git to only pull down one commit worth of historical data.

Install Dependencies

SeedularJS has two kinds of dependencies: Development Tools and AngularJS framework code. The tools help with the management and testing of the application.

Before you install anything make sure you are in the project's directory:

cd <your-project-name>
Install Tools:
npm install
Install Framework Code:
bower install

After both installs, there should now be two new folders in the project directory.

  • node_modules - contains the npm packages for the tools needed
  • bower_components - contains the AngularJS and other framework files needed

Run the App

SeedularJS is preconfigured with a simple development web server via Browser Sync. The simplest way to start this server is:

Use NPM Scripts

  • npm run build to build an optimized version of your application in /dist
  • npm run serve to launch a Browser Sync server on your source files
  • npm run serve:dist to launch a server on your optimized application
  • npm run test to launch your unit tests with Karma
  • npm run test:auto to launch your unit tests with Karma in watch mode

Or Gulp Tasks

  • gulp or gulp build
  • gulp serve
  • gulp serve:dist
  • gulp test
  • gulp test:auto

If you don't have gulp-cli installed in global, you should have this error:

/usr/local/lib/node_modules/gulp/bin/gulp.js:121 gulpInst.start.apply(gulpInst, toRun); TypeError: Cannot read property 'apply' of undefined

About

SeedularJS - A Seed for AngularJS App Projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published