Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danwahlin/angular-jumpstart
Angular and TypeScript JumpStart example application
https://github.com/danwahlin/angular-jumpstart
Last synced: about 21 hours ago
JSON representation
Angular and TypeScript JumpStart example application
- Host: GitHub
- URL: https://github.com/danwahlin/angular-jumpstart
- Owner: DanWahlin
- License: mit
- Created: 2015-10-15T00:59:33.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2024-06-27T17:48:12.000Z (5 months ago)
- Last Synced: 2024-10-29T15:38:56.536Z (22 days ago)
- Language: TypeScript
- Homepage:
- Size: 15 MB
- Stars: 1,554
- Watchers: 122
- Forks: 1,102
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Angular JumpStart with TypeScript
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.
## Angular Concepts Covered
* 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)
## Running the Application with Node.js
1. 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 current version of Node.js.*
1. Run `npm install` to install app dependencies
1. Run `ng build angular-jumpstart --watch` to build and bundle the code
1. Run `npm start` in a separate terminal window to launch the web and RESTful API server
1. 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:
## Running Cypress End to End Tests
1. Run `npm install cypress --save-dev` to install Cypress.
1. Run `npm run cypress` to start the Cypress test runner.
## Running in Kubernetes
1. Install Docker Desktop from https://www.docker.com/get-started
1. Start Docker and enable Kubernetes in the Docker Desktop preferences/settings
1. Run `docker-compose build` to create the images
1. Run `kubectl apply -f .k8s` to start Kubernetes
1. Visit `http://localhost`
1. Stop Kubernetes using `kubectl delete -f .k8s`
## Running with Skaffold
If you'd like to use the [Skaffold tool](https://skaffold.dev/docs/install) 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](https://kompose.io) 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"}'
```
## Running in the Azure Static Web Apps Service
Check out my post on [Getting Started with Azure Static Web Apps](https://blog.codewithdan.com/getting-started-with-azure-static-web-apps).
## Kubernetes Day Zero Webinar: Deploying to Kubernetes
Dan Wahlin
Twitter: @DanWahlin
https://codewithdan.com
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/
## Agenda
1. Container Orchestration Options (Docker Swarm, Kubernetes)
2. Using Docker Compose
```
docker-compose build
docker-compose up
docker-compose down
```
3. Docker Stacks --> Docker Desktop --> Kubernetes
```
docker stack deploy -c docker-compose.yml angular-jumpstart
docker stack ls
docker stack rm angular-jumpstart
```
4. Deploying Containers to Kubernetes
https://kompose.io/
```
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
# Azure Container Apps
## Build API Image
1. Go to https://github.com/danwahlin/angular-jumpstart and fork the repo.
1. Clone the forked repo to your machine.
1. Run `docker-compose build node`.
1. Tag the image with your Docker Hub repo name: `docker tag node-service-jumpstart /node-service-jumpstart`
1. `docker push /node-service-jumpstart`
## Create environment
```bash
az containerapp env create -n angular-jumpstart-env -g Angular-Jumpstart-RG \
--location westus3
```
## Deploy the API Container App
```bash
az containerapp create -n angular-jumpstart-api -g Angular-Jumpstart-RG \
--environment angular-jumpstart-env \
--image /node-service-jumpstart \
--ingress external --target-port 8080
```
> Note the fully qualified domain (fqdn) value assigned to the `angular-jumpstart-api` container app. You'll need this value in the next section.
## Add an .env File
1. Create a `.env` file in the project root.
1. Add the following key/value to the `.env` file:
```text
NG_APP_API_URL=
```
## Build the UI Image
1. Run `docker-compose build nginx`.
1. Tag the image with your Docker Hub repo name:
```bash
docker tag nginx-angular-jumpstart /nginx-angular-jumpstart
```
1. Push the image to Docker Hub:
```bash
docker push /nginx-angular-jumpstart
```
## Deploy UI Container App
Change the image name below to match your image tag from the previous step.
```bash
az containerapp create -n angular-jumpstart-ui -g Angular-Jumpstart-RG \
--environment angular-jumpstart-env \
--image /nginx-angular-jumpstart \
--ingress external --target-port 80
```
## View the UI App
Navigate to the FQDN value shown after running the previous command.
## Add GitHub Continuous Deployment
1. Create a service principal:
```bash
az ad sp create-for-rbac \
--name AngularJumpStartServicePrincipal \
--role "contributor" \
--scopes /subscriptions//resourceGroups/Angular-Jumpstart-RG \
--sdk-auth
```
1. Add a GitHub action for the UI container app:
```bash
az containerapp github-action add \
--repo-url "https://github.com//" \
--context-path "./.docker/nginx.dockerfile" \
--branch main \
--name angular-jumpstart-ui \
--image /nginx-angular-jumpstart
--resource-group Angular-Jumpstart-RG \
--registry-url docker.io \
--registry-username \
--registry-password \
--service-principal-client-id \
--service-principal-client-secret \
--service-principal-tenant-id \
--login-with-github
```
1. Add a GitHub action for the API container app:
```bash
az containerapp github-action add \
--repo-url "https://github.com//" \
--context-path "./.docker/node.dockerfile" \
--branch main \
--name angular-jumpstart-api \
--image /node-service-jumpstart
--resource-group Angular-Jumpstart-RG \
--registry-url docker.io \
--registry-username \
--registry-password \
--service-principal-client-id \
--service-principal-client-secret \
--service-principal-tenant-id \
--login-with-github
```
1. IMPORTANT: Once the GitHub actions are added, pull the latest changes to your local repository.
1. Open each action file in `.github/workflows` and change the properties under `on:` to the following (in both files):
```yaml
# When this action will be executed
on:
push:
branches:
- main
pull_request:
types: [opened, synchronize, reopened, closed]
branches:
- main
```
1. Make the following changes to each respective workflow file:
### angular-jumpstart-ui workflow
```yaml
build-args: NG_APP_API_URL=${{ secrets.NG_APP_API_URL }}
file: ./.docker/nginx.dockerfile
context: ./
```
### angular-jumpstart-api workflow
```yaml
file: ./.docker/node.dockerfile
context: ./
```
1. Go to your GitHub.com and navigate to your forked repo. Select `Settings --> Secrets --> Actions` from the toolbar.
1. Add the following key/value into the repository secrets. This is needed for the CI build that generates the UI image.
```text
NG_APP_API_URL=
```
1. Push your changes up to your repo.
1. Go to your GitHub repo on Github.com and select `Actions` from the toolbar. You should see the actions building (and hopefully deploy successfully).
1. Go to the FQDN of your `angular-jumpstart-ui` container app in the browser. The app should load if your GitHub actions deployed successfully.