Fritz
Build
Requirements
Setup
$ npm run setup
This installs the following globally:
Then install the required Node dependencies with:
$ npm install
Add a file called .env
to the root of the project with the following contents:
{
"node": {
"env": "dev"
}
}
You can now run the development server by running the following commands:
$ npm start
- You can now visit http://localhost:8081/ to view changes live.
Serverside runtime
- Uses dependency injection from Nodep
Running the test suite
Single Run:
$ gulp test
Continuous testing when files are changed:
$ gulp autotest
Generating README.md
$ gulp docs
Generating CHANGELOG.md
$ gulp changelog
Notes
- jshint is part of the test suite and should be kept clean
- Commits should have high test coverage
- Docs should be kept up to date
- Additions should come with documentation
- commit messages should follow Angular conventional format
License
Copyright (c) 2015 Beg.in
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.