{"id":23483344,"url":"https://github.com/jorgeandrespadilla/angular-quickstart-app","last_synced_at":"2026-04-11T03:32:16.349Z","repository":{"id":269505104,"uuid":"907607340","full_name":"jorgeandrespadilla/angular-quickstart-app","owner":"jorgeandrespadilla","description":"Angular Quickstart App: A template for Angular development, pre-configured with modern tools to streamline your workflow.","archived":false,"fork":false,"pushed_at":"2025-01-02T02:33:44.000Z","size":1068,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-22T03:55:32.267Z","etag":null,"topics":["angular","compodoc","eslint","playwright","storybook","typescript","vitest"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jorgeandrespadilla.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-12-24T01:35:03.000Z","updated_at":"2025-01-02T02:33:47.000Z","dependencies_parsed_at":"2025-04-14T00:09:51.803Z","dependency_job_id":"563dfa4d-40de-416e-8863-69065ed55176","html_url":"https://github.com/jorgeandrespadilla/angular-quickstart-app","commit_stats":null,"previous_names":["jorgeandrespadilla/angular-quickstart-app"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/jorgeandrespadilla/angular-quickstart-app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jorgeandrespadilla%2Fangular-quickstart-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jorgeandrespadilla%2Fangular-quickstart-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jorgeandrespadilla%2Fangular-quickstart-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jorgeandrespadilla%2Fangular-quickstart-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jorgeandrespadilla","download_url":"https://codeload.github.com/jorgeandrespadilla/angular-quickstart-app/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jorgeandrespadilla%2Fangular-quickstart-app/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31668046,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-10T17:19:37.612Z","status":"online","status_checked_at":"2026-04-11T02:00:05.776Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","compodoc","eslint","playwright","storybook","typescript","vitest"],"created_at":"2024-12-24T21:11:21.695Z","updated_at":"2026-04-11T03:32:16.312Z","avatar_url":"https://github.com/jorgeandrespadilla.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Angular Quickstart App\n\nThis project is a quickstart template for Angular applications using modern tools. It includes a set of tools and configurations to help you get started with Angular development. The project is pre-configured with a modern build system, testing tools, and other useful features to help you build high-quality Angular applications.\n\n## Features\n\n- Angular 19 (with Node.js 20)\n- TypeScript for type-checking\n- SCSS for styling\n- Support for environment variables using `.env` files\n- [esbuild](https://esbuild.github.io/) and [Vite](https://vitejs.dev/) for the build system (see more about the new build system [here](https://angular.dev/tools/cli/build-system-migration))\n- [ESLint](https://eslint.org/) for code linting\n- [Vitest](https://vitest.dev/) for unit testing\n- [Angular Testing Library](https://testing-library.com/docs/angular-testing-library/intro) for testing Angular components\n- [Playwright](https://playwright.dev/) for End-to-End (E2E) testing\n- [Storybook](https://storybook.js.org/) for component-driven development\n- [Compodoc](https://compodoc.app/) for generating documentation\n- Pre-configured `.cursorrules` file to work with [Cursor IDE](https://cursor.com/)\n\n## Folder Structure\n\nThe project structure is based on the [Angular File Structure Guide](https://angular.dev/reference/configs/file-structure) and [Fractal Design](https://hackernoon.com/fractal-a-react-app-structure-for-infinite-scale-4dab943092af).\n\n## Requirements\n\n- [Node.js](https://nodejs.org/) 20+ and npm\n- [Angular CLI](https://angular.dev/guide/setup-local) 19+\n\n## Getting Started\n\n1. Clone this repository.\n2. Run `npm install` to install the project dependencies.\n3. Create a copy of the `.env.example` file and rename it to `.env`. Update the environment variables as needed.\n\n## Environment Variables\n\nThe `.env` file is used to store sensitive information that should not be committed to the repository.\n\nEvery variable should be prefixed with `NG_APP_` to be picked up by the Angular application (to avoid conflicts with other environment variables), and can be accessed using the `import.meta.env` object.\n\nThe priority order for environment variables is as follows:\n1. Environment variables set in the system or the CLI session - e.g., `NG_APP_API_URL=https://api.example.com npm run start`\n2. `.env.[environment]` (e.g., `.env.development`, `env.test`, `.env.production`) - Useful for overriding environment variables based on the environment\n3. `.env` - The default environment file\n\n\u003e **Note:** You can use environment variables inside `index.html` using the following syntax: `%NG_APP_MY_VARIABLE%`.\n\n## Running the Application\n\nTo start a local development server, run:\n\n```bash\nnpm run start\n# or\nnpm run dev\n```\n\nOnce the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files.\n\n## Building the Application\n\nTo build the project run:\n\n```bash\nnpm run build\n```\n\nThis will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed.\n\n## Testing the Application\n\n### Unit testing\n\nTo execute unit tests with Vitest, use the following command:\n\n```bash\nnpm run test\n```\n\nAdditional commands:\n- To run the tests in watch mode, use `npm run test:watch`.\n- To run the tests using Vitest UI Mode, use `npm run test:ui`.\n- To generate a coverage report, use `npm run test:coverage`.\n\n\u003e **Note:** By default, Vitest sets the `NODE_ENV` to `test` when running the tests. However, we prefer to explicitly set the `NODE_ENV` to `test` to avoid any issues.\n\n### End-to-End (E2E) testing\n\nTo execute End-to-End (E2E) tests with Playwright, run the following command:\n\n```bash\nnpx playwright install # install the browser binaries (only needed once)\nnpm run e2e\n```\n\n## Code scaffolding\n\nAngular CLI includes powerful code scaffolding tools. To generate a new component, run:\n\n```bash\nng generate component component-name\n```\n\nFor a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:\n\n```bash\nng generate --help\n```\n\n## Other Commands\n\n### Linting\n\nTo lint your code, run:\n\n```bash\nnpm run lint\n```\n\n### Storybook (Optional)\n\nStorybook is a tool for developing UI components in isolation from your application. To start Storybook, run:\n\n```bash\nnpm run storybook\n```\n\nOnce the server is running, open your browser and navigate to `http://localhost:6006/`.\n\n### Compodoc (Optional)\n\nCompodoc is a documentation tool for Angular applications. To generate the documentation, run:\n\n```bash\nnpm run compodoc:build\n```\n\nOnce the documentation is generated, you can open it in your browser by running:\n\n```bash\nnpm run compodoc:serve\n```\n\n\u003e You can also simply run `npm run compodoc:build-and-serve` to generate and serve the documentation in one command.\n\n## Recommendations\n\n### IDEs\n\n- [Cursor IDE](https://cursor.com/)\n- [VSCode](https://code.visualstudio.com/)\n\n### Libraries\n\n- Icons: [Lucide Angular](https://lucide.dev/guide/packages/lucide-angular)\n\n## Additional Resources\n\nFor more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.\n\nFor more information about running tests with Vitest in Angular, visit the following [article](https://timdeschryver.dev/blog/angular-testing-library-with-vitest).\n\nOther testing resources (applies Jest, similar API to Vitest): \n- https://timdeschryver.dev/blog/good-testing-practices-with-angular-testing-library\n- https://timdeschryver.dev/blog/making-sure-youre-using-the-correct-query\n- https://timdeschryver.dev/blog/getting-the-most-value-out-of-your-angular-component-tests\n- To solve web component testing issues, see https://www.danywalls.com/how-to-test-custom-elements-with-angular-testing-library\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjorgeandrespadilla%2Fangular-quickstart-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjorgeandrespadilla%2Fangular-quickstart-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjorgeandrespadilla%2Fangular-quickstart-app/lists"}