#Acme Email
Make sure you have Node version >= 5.0 and NPM >= 3
Clone/Download the repo then edit
app.ts
inside/src/app/app.ts
# install the repo with npm
npm install
# start the server
npm start
# use Hot Module Replacement
npm run server:dev:hmr
go to http://0.0.0.0:3000 or http://localhost:3000 in your browser
- File Structure
- Getting Started
- Configuration
- Contributing
- TypeScript
- @Types
- Frequently asked questions
- Support, Questions, or Feedback
- License
We use the component approach in Sing App. This is the new standard for developing Angular apps and a great way to ensure maintainable code by encapsulation of our behavior logic. A component is basically a self contained app usually in a single file or a folder with each concern as a file: style, template, specs, e2e, and component class. Here's how it looks:
sing/angular2-final-seed/
├──config/ * our configuration
| ├──helpers.js * helper functions for our configuration files
│ ├──karma.conf.js * karma config file
│ ├──protractor.conf.js * protroactor config file
│ ├──webpack.local.js * our local webpack config
│ ├──webpack.dev.js * our development webpack config
│ ├──webpack.prod.js * our production webpack config
│ ├──webpack.test.js * our test webpack config
│
├──src/ * our source files that will be compiled to javascript
| ├──main.browser.ts * our entry file for our browser environment
│ │
| ├──index.html * Index.html: where we generate our index page
│ │
| ├──polyfills.ts * our polyfills file
│ │
| ├──vendor.ts * our vendor file
│ │
│ ├──app/ * WebApp: folder
│ │ └──app.ts * App.ts: a simple version of our App component components
│ │
│ └──assets/ * static assets are served here
│ ├──icon/ * our list of icons from www.favicon-generator.org
│ ├──robots.txt * for search engines to crawl your website
│ └──humans.txt * for humans to know who the developers are
│
│
├──angular-cli.json * angular cli config
├──.stylelintrc * styles lint config
├──tslint.json * typescript lint config
├──typedoc.json * typescript documentation generator
├──tsconfig.json * config that webpack uses for typescript
├──package.json * what npm uses to manage it's dependencies
└──webpack.config.js * webpack main configuration file
What you need to run this app:
node
andnpm
(brew install node
)- Ensure you're running the latest versions Node
v4.x.x
+ (orv5.x.x
) and NPM3.x.x
+
If you have
nvm
installed, which is highly recommended (brew install nvm
) you can do anvm install --lts && nvm use
in$
to run with the latest Node LTS. You can also have thiszsh
done for you automatically
npm install
to install all dependenciesnpm run server
to start the dev server in another tab
# development
npm run server
# production
npm run build:prod
npm run server:prod
# development
npm run build:dev
# production
npm run build:prod
npm run server:dev:hmr
npm run watch
Configuration files live in config/
. We are currently using webpack.
When you include a module that doesn't include Type Definitions inside of the module you can include external Type Definitions with @types
When including 3rd party modules you also need to include the type definition for the module if they don't provide one within the module. You can try to install it with @types
npm install @types/node
npm install @types/lodash
If you can't find the type definition in the registry we can make an ambient definition in this file for now. For example
declare module "my-module" {
export function doesSomething(value: string): string;
}
If you're prototyping and you will fix the types later you can also declare it as type any
declare var assert: any;
declare var _: any;
declare var $: any;
If you're importing a module that uses Node.js modules which are CommonJS you need to import as
import * as _ from 'lodash';
Contact us anytime for anything about this App or Angular 2 consulting.
This project is based on angular2-webpack-starter.