MIT License
Provides fast, reliable and extensible starter for the development of Angular projects.
angular-seed
provides the following features:
Note that this seed project requires node v4.x.x or higher and npm 2.14.7.
Here is how to speed-up the build on Windows.
In order to start the seed use:
git clone --depth 1 https://github.com/mgechev/angular-seed.git
cd angular-seed
# install the project's dependencies
npm install
# watches your files and uses livereload by default
npm start
# api document for the app
# npm run build.docs
# to start deving with livereload site and coverage as well as continuous testing
npm run start.deving
# dev build
npm run build.dev
# prod build
npm run build.prod
# prod build with AoT compilation
npm run build.prod.exp
# dev build of multiple applications (by default the value of --app is "app")
npm start -- --app baz
npm start -- --app foo
npm start -- --app bar
Does not rely on any global dependencies.
Default application server configuration
var PORT = 5555;
var LIVE_RELOAD_PORT = 4002;
var DOCS_PORT = 4003;
var APP_BASE = '/';
Configure at runtime
npm start -- --port 8080 --reload-port 4000 --base /my-app/
If you have different environments and you need to configure them to use different end points, settings, etc. you can use the files dev.ts
or prod.ts
in./tools/env/
. The name of the file is environment you want to use.
The environment can be specified by using:
npm start -- --config-env ENV_NAME
Currently the ENV_NAME
s are dev
, prod
, staging
, but you can simply add a different file "ENV_NAME.ts".
file in order to alter extra such environments.
A documentation of the provided tools can be found in tools/README.md.
Visit the Wiki page of the project.
npm test
# Development. Your app will be watched by karma
# on each change all your specs will be executed.
npm run test.watch
# NB: The command above might fail with a "EMFILE: too many open files" error.
# Some OS have a small limit of opened file descriptors (256) by default
# and will result in the EMFILE error.
# You can raise the maximum of file descriptors by running the command below:
ulimit -n 10480
# code coverage (istanbul)
# auto-generated at the end of `npm test`
# view coverage report:
npm run serve.coverage
# e2e (aka. end-to-end, integration) - In three different shell windows
# Make sure you don't have a global instance of Protractor
# Make sure you do have Java in your PATH (required for webdriver)
# npm install webdriver-manager <- Install this first for e2e testing
# npm run webdriver-update <- You will need to run this the first time
npm run webdriver-start
npm run serve.e2e
npm run e2e
# e2e live mode - Protractor interactive mode
# Instead of last command above, you can use:
npm run e2e.live
You can learn more about Protractor Interactive Mode here
Please see the CONTRIBUTING file for guidelines.
An advanced option to this seed exists here which mirrors the latest changes here but adds core support for:
write_key
here
You may use it to learn how to extend this seed for your own use cases or use the advanced seed if your project needs those features.
Forks of this project demonstrate how to extend and integrate with other libraries:
.
LICENSE
README.md
gulpfile.ts <- configuration of the gulp tasks
karma.conf.js <- configuration of the test runner
package.json <- dependencies of the project
protractor.conf.js <- e2e tests configuration
src <- source code of the application
client
app
+about
about.component.css
about.component.e2e-spec.ts
about.component.html
about.component.spec.ts
about.component.ts
about.module.ts
about.routes.ts
index.ts
+home
home.component.css
home.component.e2e-spec.ts
home.component.html
home.component.spec.ts
home.component.ts
home.module.ts
home.routes.ts
index.ts
app.component.e2e-spec.ts
app.component.html
app.component.spec.ts
app.component.ts
app.module.ts
app.routes.ts
hot_loader_main.ts
main.ts
shared
config
env.config.ts
index.ts
shared.module.ts
name-list
index.ts
name-list.service.spec.ts
name-list.service.ts
navbar
index.ts
navbar.component.css
navbar.component.html
navbar.component.ts
toolbar
index.ts
toolbar.component.css
toolbar.component.html
toolbar.component.ts
assets
data.json
svg
more.svg
css
main.css
index.html
testing
router
mock-location-strategy.ts
router-testing-providers.ts
tsconfig.json
test-main.js <- testing configuration
tools
README.md <- build documentation
config
project.config.ts <- configuration of the specific project
seed.config.interfaces.ts
seed.config.ts <- generic configuration of the seed project
seed.tslint.json <- generic tslint configuration of the seed project
config.ts <- exported configuration (merge both seed.config and project.config, project.config overrides seed.config)
debug.ts
env <- environment configuration
base.ts
dev.ts
prod.ts
manual_typings
project <- manual ambient typings for the project
sample.package.d.ts
seed <- seed manual ambient typings
autoprefixer.d.ts
colorguard.d.ts
connect-livereload.d.ts
cssnano.d.ts
doiuse.d.ts
express-history-api-fallback.d.ts
istream.d.ts
karma.d.ts
merge-stream.d.ts
open.d.ts
postcss-reporter.d.ts
slash.d.ts
stylelint.d.ts
systemjs-builder.d.ts
tildify.d.ts
tiny-lr.d.ts
walk.d.ts
tasks <- gulp tasks
project <- project specific gulp tasks
sample.task.ts
seed <- seed generic gulp tasks. They can be overriden by the project specific gulp tasks
build.assets.dev.ts
build.assets.prod.ts
build.bundles.app.ts
build.bundles.ts
build.docs.ts
build.html_css.ts
build.index.dev.ts
build.index.prod.ts
build.js.dev.ts
build.js.e2e.ts
build.js.prod.ts
build.js.test.ts
build.js.tools.ts
check.versions.ts
clean.all.ts
clean.coverage.ts
clean.dev.ts
clean.prod.ts
clean.tools.ts
copy.js.prod.ts
css-lint.ts
e2e.ts
generate.manifest.ts
karma.start.ts
serve.coverage.ts
serve.docs.ts
server.prod.ts
server.start.ts
tslint.ts
watch.dev.ts
watch.e2e.ts
watch.test.ts
webdriver.ts
utils <- build utils
project <- project specific gulp utils
sample_util.ts
project.utils.ts
seed <- seed specific gulp utils
clean.ts
code_change_tools.ts
server.ts
tasks_tools.ts
template_locals.ts
tsproject.ts
watch.ts
seed.utils.ts
utils.ts
tsconfig.json <- configuration of the typescript project (ts-node, which runs the tasks defined in gulpfile.ts)
tslint.json <- tslint configuration
typings <- typings directory. Contains all the external typing definitions defined with typings
typings.json
appveyor.yml
mgechev | ludohenin | d3viant0ne | Shyam-Chen | tarlepp | NathanWalker |
Nightapes | TheDonDope | nareshbhatia | hank-ehly | kiuka | daniru |
vyakymenko | jesperronn | njs50 | aboeglin | robstoll | sasikumardr |
gkalpak | ryzy | markwhitfeld | sfabriece | jerryorta-dev | pgrzeszczak |
eppsilon | e-oz | natarajanmca11 | domfarolino | JayKan | larsthorup |
JakePartusch | LuxDie | amedinavalencia | tsm91 | jvitor83 | juristr |
JohnCashmore | ouq77 | devanp92 | hAWKdv | JunaidZA | c-ice |
markharding | ojacquemart | tiagomapmarques | TuiKiken | evanplaice | gotenxds |
turbohappy | karlhaas | troyanskiy | Bigous | ip512 | Green-Cat |
Yonet | edud69 | inkidotcom | yassirh | taguan | bbarry |
sonicparke | brendanbenson | brian428 | briantopping | ckapilla | cadriel |
dszymczuk | dmurat | peah90 | dstockhammer | dwido | totev |
nosachamos | koodikindral | Falinor | allenhwkim | hpinsley | NN77 |
isidroamv | jeffbcross | Drane | johnjelinek | JunusErgin | justindujardin |
lihaibh | Brooooooklyn | tandu | nulldev07 | daixtrose | mjwwit |
ocombe | gdi2290 | typekpb | philipooo | redian | alexweber |
robbatt | robertpenner | Sjiep | sclausen | heavymery | tapas4java |
vincentpalita | Yalrafih | billsworld | blackheart01 | butterfieldcons | danielcrisp |
jgolla | omerfarukyilmaz | pbazurin-softheme | rossedfort | savcha | ultrasonicsoft |
amaltsev |
Here are all the awesome guys who are helping to make the project's wiki even better!
40 Minko Gechev
22 Clayton K. N. Passos
15 Shyam-Chen
14 Vincent van Proosdij
8 matthew harwood
8 Christian Dobert
8 Robert van Kints
6 Ludovic HENIN
5 Attila Egyed
4 davidgfolch
4 Chris Kapilla
3 Stefan Schller
3 Patrick Hillert
3 Ezequiel Cicala
3 Brian Kotek
2 Nathan Walker
2 Dinsitro
2 Drake Wilson
2 Simon Hampton
2 Yannick Koehler
2 Giovanni Candido da Silva
2 hhubik
2 Joshua Wiens
2 Cy Klassen
1 zcsongor
1 Ameer Nuri
1 Ankit Kamboj
1 BouncingBit
1 Dang Tung
1 Eddie Sun
1 Enrico Secondulfo
1 Eugene Serkin
1 Ishara Samantha
1 Myrmex
1 Pol Stafford
1 Raphael Schmitt
1 Robert Stoll
1 Sebastian Fuss
1 Sebastien de Salvador
1 The Ult
1 Yonet
1 graham
1 kiuka
1 silicakes
1 Adam Johannesmeyer
You can follow the Angular change log here.
MIT