Angular Open Source Starter
This is a starter project for creating open-source libraries for Angular. It is a full fledged Angular workspace with demo application and easy library addition. It is designed to be used for open-sourcing libraries on Github and has everything you'd need ready for CI, code coverage, SSR testing,...
Overview
The Angular Open-source Starter is a project designed to assist in creating open-source libraries for Angular. It provides a complete Angular workspace with a demo application and simplified library addition. This starter project is specifically tailored for open-sourcing libraries on GitHub and includes features such as CI/CD, code coverage, SSR testing, and StackBlitz demo deployment. It is a comprehensive solution for developers looking to create and share their Angular libraries.
Features
- Versioning: Easily manage versioning using Conventional Commits format, with automatically generated CHANGELOG.md on releases by Standard Version.
- Angular Universal: Test your library with SSR (Server-Side Rendering) and Prerender using npm commands like
npm run serve:dev:ssrornpm run build:prerender && npm run serve:prerender. - CI and Code Coverage: GitHub Actions ensure that packages build, test, and lint correctly, and test results are sent to Codecov.
- Precommit Checks: Includes precommit checks, prettier, linter, and other code quality tools.
- StackBlitz Demo Deployment: Easily deploy your library demo to StackBlitz using a provided link format.
- Modularity: Use Nx-generators to create multiple libraries within an Angular Workspace, with simultaneous versioning and publishing.
- Angular
Angular is a TypeScript-based open-source framework by Google for building dynamic single-page applications and cross-platform mobile apps with MVC architecture and a rich set of features.
- Express
Express.js is a simple Node.js framework for single, multi-page, and hybrid web applications.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.
