The goal of this jumpstart app is to provide a simple way to get started with Angular 2+ while also showing several key Angular features. The sample relies on the Angular CLI to build the application.
Looking for expert onsite Angular/TypeScript training? We've trained the biggest (and smallest :-)) companies around the world for over 15 years. For more information visit https://codewithdan.com.
- TypeScript version that relies on classes and modules
- Modules are loaded with System.js
- Defining routes including child routes and lazy loaded routes
- Using Custom Components including custom input and output properties
- Using Custom Directives
- Using Custom Pipes
- Defining Properties and Using Events in Components/Directives
- Using the Http object for Ajax calls along with RxJS observables
- Working with Utility and Service classes (such as for sorting and Ajax calls)
- Using Angular databinding Syntax [], () and [()]
- Using template-driven and reactive forms functionality for capturing and validating data
- Optional: Webpack functionality is available for module loading and more (see below for details)
- Optional: Ahead-of-Time (AOT) functionality is available for a production build of the project (see below for details)
An example of this application that uses standalone components (no modules) can be found in the standalone-components branch.
-
Install the latest LTS version of Node.js from https://nodejs.org. IMPORTANT: The server uses ES2015 features AND the Angular CLI so you need a modern version of Node.js.
-
Run
npm installto install app dependencies -
Run
ng build angular-jumpstartto build and bundle the code. If you'd like to build and watch the code (in case you plan to make changes) runng build angular-jumpstart --watchinstead. -
Run
npm startin a separate terminal window to launch the web and RESTful API server. This will server the APIs and the Angular app. -
Go to http://localhost:8080 in your browser
NOTE: You'll need to supply your own Google Maps API key in the shared/map.component.ts file to see the full map functionality. Update https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY with your key.
Simply clone the project or download and extract the .zip to get started.
Once the app is running you can play around with editing customers after you login. Use any email address and any password that's at least 6 characters long (with 1 digit).
Here are a few screenshots from the app:
This application includes Angular Playground (http://www.angularplayground.it) which provides a great way to isolate components in a sandbox rather than loading the entire application to see a given component. To run the playground run the following command:
npm run playground
Then open a browser and visit http://localhost:4201 and follow the directions there (or visit their website for more information).
- Run
npm install cypress --save-devto install Cypress. - Run
npm run cypressto start the Cypress test runner.
- Install Docker Desktop from https://www.docker.com/get-started
- Start Docker and enable Kubernetes in the Docker Desktop preferences/settings
- Run
docker-compose buildto create the images - Run
kubectl apply -f .k8sto start Kubernetes - Visit
http://localhost - Stop Kubernetes using
kubectl delete -f .k8s
If you'd like to use the Skaffold tool to run the project in Kubernetes, install it, and run the following command:
skaffold dev
To generate the skaffold.yaml file that's included in the project the following command was run and the image context paths it defines were modified:
skaffold init -k '.k8s/*.yml' \
-a '{"builder":"Docker","payload":{"path":".docker/nginx.dev.dockerfile"},"image":"nginx-angular-jumpstart"}' \
-a '{"builder":"Docker","payload":{"path":".docker/node.dockerfile"},"image":"node-service-jumpstart"}'
If you wanted to generate the initial Kubernetes manifest files from an existing docker-compose.yml file you can use the following command. It uses the Kompose tool behind the scenes to create the YAML files
skaffold init --compose-file docker-compose.yml \
-a '{"builder":"Docker","payload":{"path":".docker/nginx.dev.dockerfile"},"image":"nginx-angular-jumpstart"}' \
-a '{"builder":"Docker","payload":{"path":".docker/node.dockerfile"},"image":"node-service-jumpstart"}'
Check out my post on Getting Started with Azure Static Web Apps.
Dan Wahlin
Twitter: @DanWahlin
Resources mentioned:
- https://github.com/danwahlin/angular-jumpstart
- https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands
- https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.13/#-strong-api-overview-strong-
- https://kubernetes.io/docs/reference/kubectl/cheatsheet/
-
Container Orchestration Options (Docker Swarm, Kubernetes)
-
Using Docker Compose
docker-compose build docker-compose up docker-compose down -
Docker Stacks --> Docker Desktop --> Kubernetes
docker stack deploy -c docker-compose.yml angular-jumpstart docker stack ls docker stack rm angular-jumpstart -
Deploying Containers to Kubernetes
kompose convert -h kompose convert -f docker-compose.yml -o ./[your-folder-goes-here]Tweak the generated YAML. Then once ready run:
kubectl apply -f [your-folder-name]
My Kubernetes for Developers video courses on Pluralsight.com:
https://pluralsight.pxf.io/danwahlin
-
Go to https://github.com/danwahlin/angular-jumpstart and fork the repo.
-
Clone the forked repo to your machine.
-
Run
docker-compose build node. -
Tag the image with your Docker Hub repo name:
docker tag node-service-jumpstart <YOUR_DOCKER_HUB_NAME>/node-service-jumpstart -
docker push <YOUR_DOCKER_HUB_NAME>/node-service-jumpstart
az containerapp env create -n angular-jumpstart-env -g Angular-Jumpstart-RG \
--location westus3az containerapp create -n angular-jumpstart-api -g Angular-Jumpstart-RG \
--environment angular-jumpstart-env \
--image <YOUR_DOCKER_HUB_NAME>/node-service-jumpstart \
--ingress external --target-port 8080Note the fully qualified domain (fqdn) value assigned to the
angular-jumpstart-apicontainer app. You'll need this value in the next section.
-
Create a
.envfile in the project root. -
Add the following key/value to the
.envfile:
NG_APP_API_URL=<FQDN_VALUE_FROM_YOUR_angular-jumpstart-api_CONTAINER_APP>
-
Run
docker-compose build nginx. -
Tag the image with your Docker Hub repo name:
docker tag nginx-angular-jumpstart <YOUR_DOCKER_HUB_NAME>/nginx-angular-jumpstart
-
Push the image to Docker Hub:
docker push <YOUR_DOCKER_HUB_NAME>/nginx-angular-jumpstart
Change the image name below to match your image tag from the previous step.
az containerapp create -n angular-jumpstart-ui -g Angular-Jumpstart-RG \
--environment angular-jumpstart-env \
--image <YOUR_DOCKER_HUB_NAME>/nginx-angular-jumpstart \
--ingress external --target-port 80Navigate to the FQDN value shown after running the previous command.
-
Create a service principal:
az ad sp create-for-rbac \ --name AngularJumpStartServicePrincipal \ --role "contributor" \ --scopes /subscriptions/<SUBSCRIPTION_ID>/resourceGroups/Angular-Jumpstart-RG \ --sdk-auth
-
Add a GitHub action for the UI container app:
az containerapp github-action add \ --repo-url "https://github.com/<OWNER>/<REPOSITORY_NAME>" \ --context-path "./.docker/nginx.dockerfile" \ --branch main \ --name angular-jumpstart-ui \ --image <YOUR_DOCKER_HUB_NAME>/nginx-angular-jumpstart --resource-group Angular-Jumpstart-RG \ --registry-url docker.io \ --registry-username <REGISTRY_USER_NAME> \ --registry-password <REGISTRY_PASSWORD> \ --service-principal-client-id <CLIENT_ID> \ --service-principal-client-secret <CLIENT_SECRET> \ --service-principal-tenant-id <TENANT_ID> \ --login-with-github
-
Add a GitHub action for the API container app:
az containerapp github-action add \ --repo-url "https://github.com/<OWNER>/<REPOSITORY_NAME>" \ --context-path "./.docker/node.dockerfile" \ --branch main \ --name angular-jumpstart-api \ --image <YOUR_DOCKER_HUB_NAME>/node-service-jumpstart --resource-group Angular-Jumpstart-RG \ --registry-url docker.io \ --registry-username <REGISTRY_USER_NAME> \ --registry-password <REGISTRY_PASSWORD> \ --service-principal-client-id <CLIENT_ID> \ --service-principal-client-secret <CLIENT_SECRET> \ --service-principal-tenant-id <TENANT_ID> \ --login-with-github
-
IMPORTANT: Once the GitHub actions are added, pull the latest changes to your local repository.
-
Open each action file in
.github/workflowsand change the properties underon:to the following (in both files):# When this action will be executed on: push: branches: - main pull_request: types: [opened, synchronize, reopened, closed] branches: - main
-
Make the following changes to each respective workflow file:
build-args: NG_APP_API_URL=${{ secrets.NG_APP_API_URL }} file: ./.docker/nginx.dockerfile context: ./
file: ./.docker/node.dockerfile context: ./
-
Go to your GitHub.com and navigate to your forked repo. Select
Settings --> Secrets --> Actionsfrom the toolbar. -
Add the following key/value into the repository secrets. This is needed for the CI build that generates the UI image.
NG_APP_API_URL=<FQDN_VALUE_FROM_YOUR_angular-jumpstart-api_CONTAINER_APP> -
Push your changes up to your repo.
-
Go to your GitHub repo on Github.com and select
Actionsfrom the toolbar. You should see the actions building (and hopefully deploy successfully). -
Go to the FQDN of your
angular-jumpstart-uicontainer app in the browser. The app should load if your GitHub actions deployed successfully.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent