Skip to content

Commit 97eadad

Browse files
Tb/deved 333 update (#125)
* updated typescript to v4.6.4 * updated angular to v14 * updated angular cli * updated README.md
1 parent db70da4 commit 97eadad

File tree

5 files changed

+6581
-4654
lines changed

5 files changed

+6581
-4654
lines changed

README.md

Lines changed: 56 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ Click this button and it will help you create a new repo, create a new Netlify p
1919
- [Removing Renovate](#removing-renovate)
2020
- [Removing Cypress](#removing-cypress)
2121
- [Angular + Netlify Resources](#angular--netlify-resources)
22+
- [Deployment Options](#deployment-options)
23+
- [Customization](#customization)
24+
- [Styling](#styling-1)
25+
- [Updating Dependencies](#updating-dependencies)
2226

2327
## Setup
2428

@@ -72,7 +76,7 @@ If you decide that our styling is not for you, all you'll need to do is remove t
7276

7377
### Included Default Testing
7478

75-
Weve included some tooling that helps us maintain these templates. This template currently uses:
79+
We've included some tooling that helps us maintain these templates. This template currently uses:
7680

7781
- [Renovate](https://www.mend.io/free-developer-tools/renovate/) - to regularly update our dependencies
7882
- [Cypress](https://www.cypress.io/) - to run tests against how the template runs in the browser
@@ -82,11 +86,11 @@ If your team is not interested in this tooling, you can remove them with ease!
8286

8387
### Removing Renovate
8488

85-
In order to keep our project up-to-date with dependencies we use a tool called [Renovate](https://github.com/marketplace/renovate). If youre not interested in this tooling, delete the `renovate.json` file and commit that onto your main branch.
89+
In order to keep our project up-to-date with dependencies we use a tool called [Renovate](https://github.com/marketplace/renovate). If you're not interested in this tooling, delete the `renovate.json` file and commit that onto your main branch.
8690

8791
### Removing Cypress
8892

89-
For our testing, we use [Cypress](https://www.cypress.io/) for end-to-end testing. This makes sure that we can validate that our templates are rendering and displaying as wed expect. By default, we have Cypress not generate deploy links if our tests dont pass. If youd like to keep Cypress and still generate the deploy links, go into your `netlify.toml` and delete the plugin configuration lines:
93+
For our testing, we use [Cypress](https://www.cypress.io/) for end-to-end testing. This makes sure that we can validate that our templates are rendering and displaying as we'd expect. By default, we have Cypress not generate deploy links if our tests don't pass. If you'd like to keep Cypress and still generate the deploy links, go into your `netlify.toml` and delete the plugin configuration lines:
9094

9195
```diff
9296
[[plugins]]
@@ -98,13 +102,13 @@ For our testing, we use [Cypress](https://www.cypress.io/) for end-to-end testin
98102
- enable = false
99103
```
100104

101-
If youd like to remove the `netlify-plugin-cypress` build plugin entirely, youd need to delete the entire block above instead. And then make sure sure to remove the package from the dependencies using:
105+
If you'd like to remove the `netlify-plugin-cypress` build plugin entirely, you'd need to delete the entire block above instead. And then make sure sure to remove the package from the dependencies using:
102106

103107
```bash
104108
npm uninstall -D netlify-plugin-cypress
105109
```
106110

107-
And lastly if youd like to remove Cypress entirely, delete the entire `cypress` folder and the `cypress.config.ts` file. Then remove the dependency using:
111+
And lastly if you'd like to remove Cypress entirely, delete the entire `cypress` folder and the `cypress.config.ts` file. Then remove the dependency using:
108112

109113
```bash
110114
npm uninstall cypress
@@ -114,15 +118,55 @@ npm uninstall cypress
114118

115119
Here are some resources to help you on your Angular + Netlify coding fun!
116120

117-
- [A video walkthrough of the Angular Quick Start Template](https://youtu.be/rNAiN94bBUs)
118-
- [A blog post on the Angular Quick Start Template](https://www.netlify.com/blog/get-started-with-angular-on-netlify-quickly)
121+
- [Angular Docs](https://angular.dev/overview)
122+
- [Angular CLI Commands](https://angular.dev/cli)
123+
- [Angular on Netlify Configuration](https://docs.netlify.com/frameworks/angular/)
124+
- [Netlify CLI](https://docs.netlify.com/cli/get-started/)
119125

120-
- [Angular on Netlify Configuration Docs](https://docs.netlify.com/configure-builds/common-configurations/angular/)
121-
- [Angular posts via the Netlify Blog](https://www.netlify.com/tags/angular/)
122-
- [Angular in the Jamstack Tutorials](https://explorers.netlify.com/learn/angular-in-the-jamstack)
123126

124-
Hope this template helps :) Happy coding 👩🏻‍💻!
127+
## Deployment Options
128+
129+
- **One-Click**: Click the "Deploy to Netlify" button above
130+
- **CLI**: Use `netlify deploy` command
131+
- **Git Integration**: Connect your repository in the [Netlify UI](https://app.netlify.com/)
132+
- **Manual**: Drag and drop the `dist/` folder to the [Netlify UI](https://app.netlify.com/drop)
133+
134+
## Customization
135+
136+
### Styling
137+
138+
The project includes a demo stylesheet in `src/demo-styling.css` with customizable variables:
139+
140+
```css
141+
--top-right-blur-1: #20C6B7;
142+
--top-right-blur-2: #4D9ABF;
143+
--bttm-left-blur-1: #de3641;
144+
--bttm-left-blur-2: #e46b73;
145+
```
146+
147+
To remove the demo styling, delete the import from `angular.json` and `app.component.ts`.
148+
149+
### Updating Dependencies
150+
151+
To update Angular packages to compatible versions:
152+
153+
```bash
154+
ng update @angular/core @angular/cli
155+
```
156+
157+
For TypeScript compatibility issues, install a compatible version:
158+
159+
```bash
160+
npm install typescript@4.6.4 --save-dev
161+
```
162+
163+
## Testing
164+
165+
This project includes:
166+
- Unit tests with Jasmine/Karma
167+
- E2E tests with Cypress
168+
- Cypress Netlify Build Plugin
125169

126170
---
127171

128-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 13.2.5.
172+
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 14.2.13 and uses Angular 14.3.0.

angular.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,5 +103,7 @@
103103
}
104104
}
105105
},
106-
"defaultProject": "angular-quickstart"
106+
"cli": {
107+
"analytics": "6a2392ab-7487-4dbe-ae87-f0df128e77a4"
108+
}
107109
}

0 commit comments

Comments
 (0)