-
Notifications
You must be signed in to change notification settings - Fork 12k
docs: add move in/out docs #4400
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
5da82e0
docs: add move in/out docs
filipesilva 180fbe9
fix branding
filipesilva f80fda6
add -r to folder copy
filipesilva 647a8fc
incorporate John's feedback
filipesilva 5f9ead1
incorporate Ward's feedback
filipesilva 1ac0858
incorporate Jesus's feedback
filipesilva File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# Moving your project to Angular CLI | ||
|
||
The easiest way to move an existing project to Angular CLI is to copy your | ||
application files into a new, empty CLI project. | ||
|
||
Let's see how to do it step by step. | ||
Here we use a project made with the [official QuickStart](https://github.com/angular/quickstart) | ||
as an example, but you should be able to adjust these instructions to other setups. | ||
|
||
Note for Windows users: we show unix commands here like `cp -r` to copy and `rm -rf` to delete files. | ||
Windows does not have these commands so use Explorer instead. | ||
|
||
Start with preparing your existing project folder. We'll refer to it as `awesome-app`. | ||
- commit and push your existing changes. | ||
- clean your folder from temporary files and ignored files using `git clean -fdx`. | ||
- rename your project folder to `old-awesome-app`. | ||
|
||
Now make a new project on the same parent folder as `old-awesome-app` using Angular CLI. | ||
- Verify you have the [Angular CLI prerequisites](https://github.com/angular/angular-cli#prerequisites). | ||
- Install the CLI globally: `npm install -g @angular/cli`. | ||
- Make a new app: `ng new awesome-app`. | ||
- Move into the folder: `cd awesome-app`. | ||
- Test your app works: `ng serve --open`. | ||
|
||
Copy over your app files. | ||
- Remove the existing app: `rm -rf src/app src/styles.css src/index.html e2e`. | ||
- Copy `src/app/`, `src/index.html`, `src/styles.css` and `e2e/` from your old app. | ||
If you don't have a `src/` folder then these files and folders should be | ||
at the root of the old project instead. | ||
``` | ||
cp -r ../old-awesome-app/src/app ./src/app | ||
cp ../old-awesome-app/src/index.html ./src/index.html | ||
cp ../old-awesome-app/src/styles.css ./src/styles.css | ||
cp -r ../old-awesome-app/e2e ./e2e/ | ||
``` | ||
- Don't copy `../old-awesome-app/src/main.ts`. Instead compare it to the new `./src/main.ts` | ||
and manually copy any extra code the old one has. | ||
- Compare `../old-awesome-app/package.json` to the new `./package.json` and add in your | ||
third party libraries and `@types/*` packages, project descriptions and any other fields. | ||
- Run `npm install` to install any packages you added. | ||
- Copy over any other files your app needs like images into `src/assets`. | ||
Adjust paths on your app to use this folder e.g. `<img src='assets/my-image.jpg>`. | ||
|
||
There are a few adjustments you need to do to use the CLI build system. | ||
- Change any absolute paths you have for `templateUrl`, `styleUrls` or lazy loaded NgModules to | ||
relative paths instead. | ||
- Polyfills are listed in `./src/polyfills.ts` so remove `core-js` and `zone.js` from `index.html`. | ||
- SystemJS is not needed anymore, so remove it from `index.html` as well. | ||
- Instead of using `<script>` and `<link>` tags directly in `index.html`, use | ||
`angular-cli.json` instead. | ||
- Look for the `styles` array in `angular-cli.json` and add in any CSS files you have in | ||
`src/index.html`. Use a relative path from `./src/`. | ||
- Do the same for any remaining script tags as well, using the `scripts` array instead. | ||
|
||
The final step is to copy your git history so you can continue working without losing anything: | ||
- Copy over the git folder: `cp -r ../old-awesome-app/.git .git` | ||
- Commit and push your changes as normal. | ||
|
||
You can now delete `../old-awesome-app`, and you're done! | ||
|
||
The CLI runs static analysis on your code to ensure it's AOT ready, so you might run into a few | ||
new compilation errors that weren't there before. | ||
Check out this [handy list of AOT Do's and Dont's](https://github.com/rangle/angular-2-aot-sandbox#aot-dos-and-donts) | ||
if you get any unfamiliar errors. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Moving your project out of Angular CLI | ||
|
||
Each project is unique, and even though we try to cater to most setups in Angular CLI sometimes | ||
you need a custom setup. | ||
|
||
Even if you need to use a different build system, you can still use other Angular CLI features | ||
like `ng generate`, `ng lint`, `ng test` and `ng e2e` by leaving in `angular-cli.json` and | ||
supporting files like `src/test.ts`. | ||
|
||
Moving out of the CLI is very similar to [Moving into the CLI](moving-into-the-cli). | ||
You'll have to make a brand new project using your new project seed, move your app files and | ||
cater to any changes in the build process. | ||
|
||
Start with preparing your existing project folder. We'll refer to it as `awesome-app`. | ||
- commit and push your existing changes. | ||
- clean your folder from temporary files and ignored files using `git clean -fdx`. | ||
- rename your project folder to `old-awesome-app`. | ||
|
||
Now make a new project on the same parent folder as `old-awesome-app`. | ||
- Make a new app using your new project seed in a new `awesome-app` folder. | ||
- Move into the folder: `cd awesome-app`. | ||
|
||
Copy over your app files. | ||
- Locate `app/`, `styles.css` and the end-to-end test folder in your new project. | ||
- Replace them with the corresponding files from `../old-awesome-app`. | ||
- If your styles are not in CSS, you'll need to convert them to CSS since the quickstart doesn't | ||
use style preprocessors. You can also add preprocessor support yourself. | ||
- Copy over the code your app needs from the `environments/` folder, if any. | ||
You'll have to find another way to switch environments on the Quickstart. | ||
- Don't copy `../old-awesome-app/src/main.ts`. It contains custom logic for the CLI | ||
`environments` feature. Instead compare code and take only what you need. | ||
- Do the same for `index.html`. | ||
- Compare `../old-awesome-app/package.json` to the new `./package.json` and add in your | ||
third party libraries and `@types/*` packages, project descriptions and any other fields. | ||
- Run `npm install` to install any packages you added. | ||
- Copy over any other files your app needs like images, icons, etc. | ||
|
||
You might also need to make adjustments to conform to your new build system. | ||
- The CLI only allows relative paths in `templateUrl`, `styleUrls` or lazy loaded NgModules. | ||
You might need to change these. | ||
- Polyfills are listed in `../old-awesome-app/src/polyfills.ts`. Incorporate these into the new | ||
project. | ||
- The CLI lists used `<script>` and `<link>` tags in the `angular-cli.json` `scripts` | ||
and `styles` array. Check import these in your new project and add them accordingly. | ||
|
||
The final step is to copy your git history so you can continue working without losing anything: | ||
- Copy over the git folder: `cp -r ../old-awesome-app/.git .git` | ||
- Commit and push your changes as normal. | ||
|
||
You can now delete `../old-awesome-app`, and you're done! | ||
|
||
Every project seed does things slightly different so if you are running into problems be sure | ||
to ask in their issue tracker. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to other setups --> to your app
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you clarify how this edit would help? If an app is using the quickstart setup, these are the instructions they should follow and would need no adjustment. You only need to adjust if you're not using the quickstart boilerplate.