Introduction
GoEngin Facebook Group Web Open Source Project(https://www.facebook.com/groups/goengin/)
How to start
Note that this seed project requires node v4.x.x or higher and npm 2.14.7.
You must have ts-node
installed as global. If you don't, use:
npm install -g ts-node
In order to start the seed use:
git clone --depth 1 https://github.com/GoEngin/GoEngin.git
cd GoEngin
# install the project's dependencies
sudo npm install
# post install the project's dependencies
sudo npm run postinstall
# watches your files and uses livereload by default
npm start
# api document for the app
npm run docs
# dev build
npm run build.dev
# prod build
npm run build.prod
Does not rely on any global dependencies.
Table of Content
- Introduction
- How to start
- Table of Content
- Configuration
- How to extend?
- Running tests
- Contributing
- Directory Structure
- Change Log
- License
Configuration
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/
How to extend?
Visit the Wiki page of the project.
Running tests
npm test
# Debug - In two different shell windows
npm run build.test.watch # 1st window
npm run karma.start # 2nd window
# 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
# 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
Contributing
Please see the CONTRIBUTING file for guidelines.
Directory Structure
.
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── src
│ ├── components
│ ├── services
│ ├── styles
│ ├── images
│ ├── hot_loader_main.ts
│ ├── main.ts
│ └── index.html
├── dist
├── tools
│ ├── manual_typings
│ ├── tasks
│ ├── utils
│ ├── config.ts
│ └── utils.ts
├── appveyor.yml
├── gulpfile.ts
├── karma.conf.js
├── package.json
├── protractor.conf.js
├── test-main.js
├── tsconfig.json
├── tslint.json
└── typings.json
Change Log
You can follow the Angular 2 change log here.
License
MIT