]> git.proxmox.com Git - extjs.git/blame - extjs/templates/executive-dashboard/Readme.md
add extjs 6.0.1 sources
[extjs.git] / extjs / templates / executive-dashboard / Readme.md
CommitLineData
6527f429
DM
1# ExecDashboard\r
2\r
3This folder is primarily a container for the top-level pieces of the application.\r
4While you can remove some files and folders that this application does not use,\r
5be sure to read below before deciding what can be deleted and what needs to be\r
6kept in source control.\r
7\r
8The following files are all needed to build and load the application.\r
9\r
10 - `"app.json"` - The application descriptor which controls how the application is\r
11 built and loaded.\r
12 - `"app.js"` - The file that launches the application. This is primarily used to\r
13 launch an instance of the `MyApp.Application` class.\r
14 - `"index.html"` - The default web page for this application. This can be customized\r
15 in `"app.json"`.\r
16 - `"build.xml"` - The entry point for Sencha Cmd to access the generated build\r
17 script. This file is a place where you can hook into these processes and tune\r
18 them. See the comments in that file for more information.\r
19 - `".sencha"` - This (typically hidden) folder contains the generated build scripts\r
20 and configuration files for the application. This folder is required in order to\r
21 build the application but its content should not need to be edited in most cases.\r
22 The content of this folder is updated by "sencha app upgrade".\r
23\r
24These files can be ignored from source control as they are regenerated by the build\r
25process.\r
26\r
27 - `"build"` - This folder contain the output of the build. The generated CSS file,\r
28 consolidated resources and concatenated JavaScript file are all stored in this\r
29 folder.\r
30 - `"bootstrap.*"` - These files are generated by the build and watch commands to\r
31 enable the application to load in "development mode".\r
32\r
33# Other Folders\r
34\r
35## ExecDashboard/app\r
36\r
37This folder contains the JavaScript files for the application.\r
38\r
39## ExecDashboard/resources\r
40\r
41This folder contains static resources (typically an `"images"` folder as well).\r
42\r
43## ExecDashboard/overrides\r
44\r
45This folder contains override classes. All overrides in this folder will be \r
46automatically included in application builds if the target class of the override\r
47is loaded.\r
48\r
49## ExecDashboard/sass\r
50\r
51This folder contains the styling for the application's views. See ExecDashboard/sass/Readme.md\r
52for details.\r