Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

docs(setup): instructs to delete non-essential files #3079

Merged
merged 1 commit into from
Jan 6, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions public/docs/_examples/setup/ts/non-essential-files.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.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
9 changes: 9 additions & 0 deletions public/docs/ts/latest/guide/setup-systemjs-anatomy.jade
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,15 @@ table(width="100%")
:marked
Script to run <a href="https://karma-runner.github.io/1.0/index.html" target="_blank" title="Karma unit test runner">karma</a>
with SystemJS as described in the [Testing](testing.html) guide.
tr
td <code>non-essential-files.txt</code>
td
:marked
A list of files that you can delete if you want to purge your setup of the
original QuickStart Seed testing and git maintainence artifacts.
See instructions in the optional
[_Deleting non-essential files_](setup.html#non-essential "Setup: Deleting non-essential files") section.
*Do this only in the beginning to avoid accidentally deleting your own tests and git setup!*
tr
td <code>LICENSE</code>
td
Expand Down
31 changes: 30 additions & 1 deletion public/docs/ts/latest/guide/setup.jade
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,36 @@ code-example(language="sh" class="code-shell").
:marked
`npm start` fails in _Bash for Windows_ which does not support networking to servers as of January, 2017.

.l-main-section#seed
a#non-essential
.l-main-section
:marked
## 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`!).

.alert.is-important
:marked
Do this only in the beginning to avoid accidentally deleting your own tests and git setup!

:marked
Open a terminal window in the project folder and enter the following commands for your environment:

### OS/X (bash)
code-example(language="sh" class="code-shell").
xargs -a non-essential-files.txt rm -rf
rm app/*.spec*.ts
rm non-essential-files.txt

:marked
### Windows
code-example(language="sh" class="code-shell").
for /f %i in (non-essential-files.txt) do del %i /F /S /Q
rd .git /s /q
rd e2e /s /q

a#seed
.l-main-section
:marked
## What's in the QuickStart seed?

Expand Down