NgJkmdev
A collection of angular libraries containing components and utilities that can be included in other projects. Project documentation can be found here.
This project was generated with Angular CLI version 7.3.8.
Current Libraries
NgJkmdevGithub
A collection of angular components that obtain a Github user's data and displays them visually. Primarilly intended to be used in portfolio sites, or wherever they may be relevant.
Getting Started
Prerequisites
- Node.js (LTS/stable or current version)
- npm package manager
- Angular, angular-cli
Installing
Get a local version of the project onto your system, then install dependencies.
git clone git@github.com:jkmdev/ng-jkmdev.git
cd ng-jkmdev
npm iThe top level project is called a workspace. Libraries are store under the projects folder.
Each project/library won't have its own dependencies; for that it will rely on the parent workspace.
If a project requires a new dependency, it must be installed in the root folder, with a reference to that depenency being manually listed in the project's package.json file afterwards.
Development server
Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
The server is primarilly serving files from projects/ng-jkmdev-tester. Said project is a standalone angular application; libraries that are being worked on will be imported into it and tested there before being imported into external apps.
Libraries imported into the tester application will need to be built first before doing so. More on that in the next section.
Build Library
Run ng build <library-name> in the root folder to build a library. The build artifacts will be stored in the dist/ directory for said library.
Running unit tests
Run ng test in the root folder to execute the unit tests for all libraries/projects via Karma.
Versioning
SemVer is used for the versioning of each library.
License
This project is licensed under the MIT License - see the LICENSE.md file for details