From ad96661dda6b16b3f5498677997957d12a878fca Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Wed, 6 Sep 2017 15:52:46 +0200 Subject: [PATCH] update structure docs --- .gitignore | 1 + docs/structure.md | 19 ++++++++++++++++++- 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 664c487..cd38b95 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +.nogit/ node_modules/ test/ pages/ diff --git a/docs/structure.md b/docs/structure.md index bf486a5..95319c7 100644 --- a/docs/structure.md +++ b/docs/structure.md @@ -2,4 +2,21 @@ name: npmts project structure description: how npmts projects are structured --- -# npmts - Project Structure \ No newline at end of file +# npmts - Project Structure + +**locally** + +```text +projectroot +|- .nogit/ # contains files that should not be checked into git - NOgit +|- dist/ # contains compiled js files and their corresponding typings - git +|- node_modules/ # contains the installed node modules - NOgit +|- test/ # contains the test files - git +|- ts/ # contains the source TypeScript files - git +| +|- .gitignore # the normal gitignore file +|- .gitlab-ci.yml # the gitlab ci yml file +|- npmextra.json # npmextra.json +``` + +**in git**