https://github.com/aavanzyl/ngx-tiny
Implementation of Light Weight Angular Components for Production Applications
https://github.com/aavanzyl/ngx-tiny
angular angular-library angular8 code-highlight multi-select ngx-tiny tabs
Last synced: 3 months ago
JSON representation
Implementation of Light Weight Angular Components for Production Applications
- Host: GitHub
- URL: https://github.com/aavanzyl/ngx-tiny
- Owner: aavanzyl
- License: mit
- Created: 2019-11-05T07:27:15.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-07T05:00:58.000Z (over 2 years ago)
- Last Synced: 2025-04-13T16:05:50.789Z (9 months ago)
- Topics: angular, angular-library, angular8, code-highlight, multi-select, ngx-tiny, tabs
- Language: TypeScript
- Homepage: https://aavanzyl.github.io/ngx-tiny
- Size: 8.37 MB
- Stars: 7
- Watchers: 2
- Forks: 3
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ngx-tiny
Production ready Angular components build for my personal project I am now open sourcing for use by the community.
* Light Weight Angular Component Library.
* Angular 10 Implementation
* Compatible with Angular SSR
* Limited to no Dependencies. When ever possible and in most cases, zero dependencies are added to the modules.
Documentation can be found here : [Read ngx-tiny Docs](https://aavanzyl.github.io/ngx-tiny)
Projects I use this:
* [Advory Wedding Directory](https://advory.co.za)
### Libs:
Inputs
* [ngx-single-select][ngx-single-select]
* [ngx-multi-select][ngx-multi-select]
* [ngx-switch-input][ngx-switch-input]
* [ngx-date-picker][ngx-date-picker]
* [ngx-time-picker][ngx-time-picker]
* [ngx-quill-editor][ngx-quill-editor]
Components
* [ngx-code-highlight][ngx-code-highlight]
* [ngx-tabs][ngx-tabs]
Directives
* [ngx-clipboard][ngx-clipboard]
Services
* [ngx-gtag][ngx-gtag]
## Development
#### Local Development
1. Run `npm run build` to build all the packages, after this, to build a single package run `npm run package:
2. Run `ng serve` to serve the documentation where the usage of the packages will be pulled in
#### Adding a new package
1. Create a new `nxg-` under `dist`
2. Update `paths` in `tsconfig.json` to include the new package
3. Add new script to `package.json` under `package:` that will enable compilation of package during build
4. Update `angular.js` to include the package as part of its build cycle
5. Add new package to `app/shared/shared.module.ts` for angular to import the components
6. Update the `app-routing`, `side-menu` with your new component section following other component sections patterns
#### Package Deployment
1. Update the `version` in the package being updated
2. Run `npm run build` to build all the packages ready for production
3. Commit the changes before running `npm run docs` to separate the commits from each other
4. Run `npm run docs` to compile the docs for github pages and commit changes.
5. Navigate to `dist/` and run `npm publish` to publish the packages that was updated.
## Support
Support me by [becoming a patron](https://www.patreon.com/bePatron?u=27640996) and buying me a beer :)
## License
See the [LICENSE][license] file.
[license]: /LICENSE
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[ngx-single-select]: projects/ngx-single-select/README.md
[ngx-multi-select]: projects/ngx-multi-select/README.md
[ngx-code-highlight]: projects/ngx-code-highlight/README.md
[ngx-quill-editor]: projects/ngx-quill-editor/README.md
[ngx-switch-input]: projects/ngx-switch-input/README.md
[ngx-date-picker]: projects/ngx-date-picker/README.md
[ngx-time-picker]: projects/ngx-time-picker/README.md
[ngx-clipboard]: projects/ngx-clipboard/README.md
[ngx-gtag]: projects/ngx-gtag/README.md
[ngx-tabs]: projects/ngx-tabs/README.md