You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-7Lines changed: 12 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,15 +87,17 @@ Within the download you'll find the following directories and files, logically g
87
87
88
88
```
89
89
backstrap/
90
-
├── build/
91
-
├── src/
92
-
│ ├── css/
90
+
├── build/
91
+
├── dist/ --> DON'T CHANGE; this is just a copy of the "src/" folder, to be used in production; don't make changes here - they will be overwritten by the build process; this folder will only show up after npm run build;
92
+
├── pug/ --> YES CHANGE; this is where the preview file code lives; these files get turned into the HTML files inside the "src/" folder one runs npm run pug;
93
+
├── src/ --> YES CHANGE; this is where the actual source code lies, and where changes should be made;
94
+
│ ├── css/ --> DON'T CHANGE; these files are generated; modify the SCSS files instead;
93
95
│ ├── img/
94
96
│ ├── js/
95
-
│ ├── scss/
97
+
│ ├── scss/ --> YES CHANGE; this is where you'll want to make CSS changes; these files get bundled and compiled, and inserted automatically inside the "src/css" folder; then the build process will copy all "src" contents inside the "dist/css" folder, so in the end your changes inside the "src/scss" folder will end up in "dist/css";
96
98
│ ├── vendors/
97
99
│ ├── ...
98
-
│ ├── index.html
100
+
│ ├── index.html --> DON'T CHANGE; the HTML files are only used for previewing the template; they get generated from the "pug" folder, so don't modify them directly, your changes will get overwritten by the build process; modify the pug files instead;
99
101
│ └── ...
100
102
└── package.json
101
103
```
@@ -112,9 +114,12 @@ Until then, you can check out the documentation for the CoreUI Free Bootstrap Ad
112
114
113
115
## Contributing
114
116
115
-
This template is just [one CSS file](https://github.com/Laravel-Backpack/BackStrap/blob/master/src/css/backstrap.css) added on top of CoreUI.
117
+
If you encounter any bugs that are NOT design-related, please [submit a ticket to the CoreUI repository](https://github.com/coreui/coreui-free-bootstrap-admin-template). We regularly merge their new releases. So all fixes there will shortly be pulled into BackStrap.
116
118
117
-
If you encounter any bugs that are NOT design-related, please [submit a ticket to the CoreUI repository](https://github.com/coreui/coreui-free-bootstrap-admin-template). We regularly merge their new releases. So all fix there will shortly be pulled into BackStrap.
119
+
The way this works is that:
120
+
- preview (HTML) changes should be done inside the ```pug``` directory; then run ```npm run pug``` to turn those PUG files into HTML files inside the ```src``` folder;
121
+
- design (CSS) changes should be done inside the ```src/scss``` directory;
122
+
- after you're happy with the changes you've made, you should run ```npm run build``` to compile the changes you've made inside the ```src``` folder to the ```dist``` folder, which includes the files people actually use in production;
<divclass="card-body">Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat.</div>
<divclass="card-header">Card with label<spanclass="badge badge-success float-right">Success</span></div>
179
172
<divclass="card-body">Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat.</div>
<divclass="card-header">Card with label<spanclass="badge badge-pill badge-danger float-right">42</span></div>
190
179
<divclass="card-body">Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat.</div>
0 commit comments