Skip to content

aavanzyl/ngx-tiny

Repository files navigation

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

Projects I use this:

Libs:

Inputs

Components

Directives

Services

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-<package-name> under dist
  2. Update paths in tsconfig.json to include the new package
  3. Add new script to package.json under package:<package-name> 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/<package-name> and run npm publish to publish the packages that was updated.

Support

Support me by becoming a patron and buying me a beer :)

License

See the LICENSE file.