Commit eda3873c authored by Ward Bell's avatar Ward Bell

chore: add non-essential-files.txt and instrucs

parent 588fd3c2
...@@ -3,8 +3,12 @@ Upgraders: for a fresh start, consider running these commands ...@@ -3,8 +3,12 @@ Upgraders: for a fresh start, consider running these commands
* `git clean -xdf` * `git clean -xdf`
* `npm install` * `npm install`
<a name="0.2.22"></a>
# 0.2.22 (2017-01-05)
* Add `non-essential-files.txt` and instructions to use it to README
<a name="0.2.21"></a> <a name="0.2.21"></a>
# 0.2.20 (2016-12-14) # 0.2.21 (2016-12-14)
* Update to in-memory-web-api v.0.2.1 * Update to in-memory-web-api v.0.2.1
<a name="0.2.20"></a> <a name="0.2.20"></a>
......
...@@ -28,33 +28,55 @@ We recommend [nvm](https://github.com/creationix/nvm) for managing multiple vers ...@@ -28,33 +28,55 @@ We recommend [nvm](https://github.com/creationix/nvm) for managing multiple vers
## Create a new project based on the QuickStart ## Create a new project based on the QuickStart
Clone this repo into new project folder (e.g., `my-proj`). Clone this repo into new project folder (e.g., `my-proj`).
```bash ```shell
git clone https://github.com/angular/quickstart my-proj git clone https://github.com/angular/quickstart my-proj
cd my-proj cd my-proj
``` ```
We have no intention of updating the source on `angular/quickstart`. We have no intention of updating the source on `angular/quickstart`.
Discard everything "git-like" by deleting the `.git` folder. Discard the `.git` folder..
```bash ```shell
rm -rf .git # non-Windows rm -rf .git # OS/X (bash)
rd .git /S/Q # windows rd .git /S/Q # windows
``` ```
### Delete _non-essential_ files (optional)
You can quickly delete the _non-essential_ files that concern testing and QuickStart repository maintenance
(***including all git-related artifacts*** such as the `.git` folder and `.gitignore`!)
by entering the following commands while in the project folder:
##### OS/X (bash)
```shell
xargs -a non-essential-files.txt rm -rf
rm app/*.spec*.ts
rm non-essential-files.txt
```
##### Windows
```shell
for /f %i in (non-essential-files.txt) do del %i /F /S /Q
rd .git /s /q
rd e2e /s /q
```
### Create a new git repo ### Create a new git repo
You could [start writing code](#start-development) now and throw it all away when you're done. You could [start writing code](#start-development) now and throw it all away when you're done.
If you'd rather preserve your work under source control, consider taking the following steps. If you'd rather preserve your work under source control, consider taking the following steps.
Initialize this project as a *local git repo* and make the first commit: Initialize this project as a *local git repo* and make the first commit:
```bash ```shell
git init git init
git add . git add .
git commit -m "Initial commit" git commit -m "Initial commit"
``` ```
>Recover the deleted `.gitignore` from the QuickStart repository
if you lost it in the _Delete non-essential files_ step.
Create a *remote repository* for this project on the service of your choice. Create a *remote repository* for this project on the service of your choice.
Grab its address (e.g. *`https://github.com/<my-org>/my-proj.git`*) and push the *local repo* to the *remote*. Grab its address (e.g. *`https://github.com/<my-org>/my-proj.git`*) and push the *local repo* to the *remote*.
```bash ```shell
git remote add origin <repo-address> git remote add origin <repo-address>
git push -u origin master git push -u origin master
``` ```
...@@ -64,7 +86,7 @@ git push -u origin master ...@@ -64,7 +86,7 @@ git push -u origin master
Install the npm packages described in the `package.json` and verify that it works: Install the npm packages described in the `package.json` and verify that it works:
```bash ```shell
npm install npm install
npm start npm start
``` ```
......
.git
.gitignore
.travis.yml
*.spec*.ts
CHANGELOG.md
e2e
favicon.ico
karma.conf.js
karma-test-shim.js
LICENSE
non-essential-files.txt
protractor.config.js
README.md
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment