-
Notifications
You must be signed in to change notification settings - Fork 6
File Structure
Jayson Harshbarger edited this page Nov 18, 2016
·
1 revision
.
├── app/ <- browser application resources
│ ├── bundles/ <- resource bundles
│ ├── common/ <- shared tools
│ │ ├── components/
│ │ ├── directives/
│ │ ├── filters/
│ │ ├── partials/
│ │ ├── services/
│ │ └── styles/
│ ├── components/ <- site components (pages)
│ │ ├── about/
│ │ ├── error/
│ │ ├── boot.js
│ │ ├── app.js
│ │ ├── app.css
│ │ └── routes.js
│ ├── electron.js <- electron entry point
│ └── index.html <- single page application
├── gulp/
│ ├── tasks/ <- gulp tasks
│ │ ├── build.js
│ │ ├── deploy.js
│ │ ├── jspm.js
│ │ ├── electron.js
│ │ ├── other.js
│ │ └── server.js
│ └── config.js <- gulp config
├── dataset/ <- datasets
│ └── example/ <- default example dataset
│ └── ... <- see File Structure of datasets below
├── .tmp/ <- temporary build goes here
├── dist/ <- build goes here
├── node_modules/ <- npm packages are installed here
├── jspm_packages/ <- jspm packages are installed here
├── package.json <- metadata used by npm and jspm
├── system.config.js <- SystemJS configuration generated by jspm
├── gulpfile.babel.js <- gulp script
├── CHANGELOG.md
├── README.md
├── credits.md
└── todo.md
File structure of a sub-project (dataset) is similar that of the Project-χ root structure. All directories and files are optional.
.
├── app/ <- application resources here override Project-Chi/app
│ ├── components/ <- site components combine with and override Project-Chi/app/components/
│ ├── common/ <- shared tools that combine with and override Project-Chi/app/common/
│ ├── data/ <- special data folder that will be symlinked on build, good for large data
│ └── index.html <- optionally override Project-Chi/app/index.html (usually not needed)
└── gulp/
└── config.js <- gulp config augments (deep-extends) Project-Chi/app/gulp/config.js`