Utility library to create beautiful stat sites
To install it as of now you need to require it like this:
npm install --save @itrulia/nova
This will add the @itrulia/nova dependency in to your package.json
Here's a brief intro about what a developer must do in order to start developing the project further:
git clone https://github.com/Itrulia/nova.git nova
cd nova/
npm install
This will download all dependencies so that you are ready to go.
If you want to generate the documentation or the typedefinition you need to rund the following command:
npm run build
This will generate the following in the dist
directory
angular-docs: the generated Angular documentation about the project. This includes relations between modules, provided services, declared and exported components/pipes/directives etc.
api-docs: the generated API documentation about the project
everything else: the transpiled JavaScript and the Typescript typedefinition files.
If you want to run the tests you have 2 options how to run them. Either you run them only once or enable the TDD (Test Driven Development) mode. The commands are the following:
For running the tests once:
npm test
For running the tests in TDD mode:
npm run tdd
You will need to publish this to the github and npm repository.
To do this you will need to do the following steps:
- As soon as you are done with development (don't forget the tests if necessary please ;) ) please commit your code
- After that you will need to update the version number of the package.json, please do this via the npm version tool. Don't forget to set the correct version number according to the SEMVER guidelines.
- Please push your code to master now and set a tag (same version as you set earlier) with a
v
prefix (e.g.v1.1.0
) and add release notes for what has changed so everyone knows what to do when there are breaking changes and what has changed for them. - Now you are ready to publish it to the npm repository. You can do this via
npm publish
. Further information can be founde on the official npm documentation page.
TODO
When you publish something open source, one of the greatest motivations is that anyone can just jump in and start contributing to your project.
To make it easier for everyone to contribute to this project and understand it, please always update the documentation when you create or modify anything.
Also always try to improve atleast 1 small thing when you are already there so that over time the project gets better and better, this is also known as The Boy Scout Rule.
Copyright (c) 2018 Karl Merkli
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.