update structure docs

This commit is contained in:
Philipp Kunz 2017-09-06 15:52:46 +02:00
parent 2fc6c3d358
commit ad96661dda
2 changed files with 19 additions and 1 deletions

1
.gitignore vendored
View File

@ -1,3 +1,4 @@
.nogit/
node_modules/ node_modules/
test/ test/
pages/ pages/

View File

@ -3,3 +3,20 @@ name: npmts project structure
description: how npmts projects are structured description: how npmts projects are structured
--- ---
# npmts - Project Structure # 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**