Skip to content

Tiny Angular version 1 app written in Typescript with modularized Gulp tasks. Perfect as boilerplate.

Notifications You must be signed in to change notification settings

Serabass/angular-typescript

 
 

Repository files navigation

Angular Typescript app

Tiny Angular app written in Typescript perfect as boilerplate.

Angular Typescript

Getting started

Prerequisites: You need to have nodejs npm and git installed

  • Clone or download the repo
  • Run sudo npm install -g gulp bower tsd ( install global tools )
  • cd into the project folder
  • Run npm run build ( install project tools, libs and typings )
  • run gulp watch (if you want build and serve the frontend and automatic reload the browser in case of changes, good for development)
  • or gulp ( build frontend ) and gulp serve ( serve the dist folder ).

Note: if you want to change port of the static server go to gulp_tasks/gulp.serve.js file

TL;DR

###Folder structure

  • src folder contains the source code, here is where you need to work

  • dist folder contains the deployed folder this is what is served when you run gulp serve or gulp watch

  • in the src folder the app is bootstrap in the components/app.ts file

  • in the src folder each component has its own folder containing controller and view. The home controller for example will have:

  • components/home/home.ts (angular controller in Typescript)

  • components/home/home.html (HTML view)

  • components/home/_home.scss (SASS style)

###Tasks (Gulp)

  • The app use Gulp as task manager, mostly you will use gulp watch and gulp. You can see all the tasks in by running gulp help.
  • The configuration for gulp is in gulp.config.js file.

It supports sourcemaps for Typescript

Angular Typescript

###Frontend library dependency manager (Bower)

  • Third party libs are managed with Bower. It comes down to two basically commands: bower install <package> and bower update. Bower keeps track of these packages in a manifest file, bower.json.

###Typescript

  • This app is written in Typescript.
  • The Typescript Definition are managed by tsd and are downloaded by tsd in the folder typings. The type definition file for the libs (src/typings/tsd.d.ts) is automatically genereated.
  • For manage type definitions there are two main commands tsd install <package> --resolve --save for install and tsd query angular* for search, for more info follow the guide on tsd.
  • The type definition references of your app go to the file src/_app.d.ts.

Useful resources for learn Typescript and Angular:

Resources & Articles

Very very good read on folder structure and Style guide

Folder structure

Todd Motto Style guide

John Papa Style guide

Simple Angualr Typescript written by Dan Wahlin

About

Tiny Angular version 1 app written in Typescript with modularized Gulp tasks. Perfect as boilerplate.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 47.7%
  • TypeScript 30.1%
  • HTML 16.0%
  • CSS 6.2%