Skip to content

thisissoon/angular-starter

Repository files navigation

Angular Starter

CircleCI Coverage Status

An example Angular project by SOON_

This project was generated with Angular CLI version 1.7.4.

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.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

Making Commits

This repo uses Commitizen CLI and Conventional Changelog to create commits and generate changelogs. Instead of running git commit run git cz and follow the prompts. Changelogs will then be generated when creating new releases by running npm run release.

Making Releases

Run npm run release to create a new release. This will use Standard Version to create a new release. Standard Version will generate / update the changelog based on commits generated using Commitizen CLI, update the version number following semantic versioning rules and then commit and tag the commit for the release. Simply run git push --follow-tags origin master.

Server side rendering

The app can be rendered on a server before serving pages to the client. Server side rendering is achieved using Express and Angular Universal with Express running a node web server and @nguniversal/express-engine providing a template engine for Express to render the angular pages.

Run npm run build:ssr && npm run serve:ssr to build client and server bundles and run an express app which will render the angular templates before being sent to the client. Navigate to http://localhost:4000/ to view the SSR version of the app.