Skip to content

mohammad-haji/ngir

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo of the project

NGIR · Build Status npm PRs Welcome GitHub license

Additional information or tag line

A brief description of your project, what it is used for.

Installing / Getting started

Install Nodejs v6+
then run below commands:

npm install -g yarn    
yarn install      
ng serve      

open your browser on http://localhost:4200/
.

Developing

Building

Production build:

npm run build    

SSR build:

npm run build:ssr    

AOT build:

npm run build:prerender    

Deploying / Publishing

The build project will be in dist/ directory.

Versioning

We can maybe use SemVer for versioning. For the versions available, see the link to tags on this repository.

  1. Make changes
  2. Commit those changes
  3. Make sure Travis turns green
  4. Bump version in package.json
  5. npm run version
  6. Commit package.json and CHANGELOG.md files
  7. Tag
  8. Push

Documentation

Building project documentation from DOCStrings:

npm run compodoc    

then serve the documentation/ directory.

Configuration

Here you should write what are all of the configurations a user can enter when
using the project.

Tests

Describe and show how to run the tests with code examples.
Explain what these tests test and why.

Give an example      

Style guide

Based on Angular offcial Style guide:
https://angular.io/guide/styleguide

Licensing

State what the license is and how to find the text version of the license.