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
@@ -35,36 +35,19 @@ Feel free to give feedback and improvements to the repo.
35
35
**[node-ts-master:](https://github.com/CKGrafico/Frontend-Boilerplates/tree/node-ts-master)** Stable version of a **Nodejs with TypeScript** example with SCSS and Nodejs.
36
36
<br>**[node-ts-dev:](https://github.com/CKGrafico/Frontend-Boilerplates/tree/node-ts-dev)** Dev version of a **Nodejs with TypeScript** example with SCSS and Nodejs.
37
37
38
-
## 🍩 App Features
39
-
On this branch _(Basic)_we use:
38
+
## 🍩 Boilerplate Features
39
+
On this branch we use:
40
40
-**BEM + BEMIT + etc:** A mix of BEM and related-BEM technologies to create conventions for CSS classes.
41
-
-**TypeScript:** This project uses TypeScript instead of JavaScript.
42
-
-**Linting:** Linting for JavaScript and SASS.
43
-
-**Normalize:** Normalize our css, you can extend it easily.
41
+
-**TypeScript:** All the code uses TypeScript.
42
+
-**Linting:** Linting for TypeScript and SASS.
44
43
-**SASS:** Scss structure with good practises.
45
44
46
45
**[⬆️ back to top](#quickstart)**
47
46
48
47
## ⚙️ Automated Tasks
49
-
On this branch _(Basic)_ we use:
50
-
-**Concurrently:** Execute two tasks in parallel.
51
-
-**Gulp Autoprefixer:** Add browser prefixes for last two versions of the browsers.
52
-
-**Gulp Clean CSS:** To minify CSS.
53
-
-**Gulp Environment:** Call to different tasks depending of the environment.
54
-
-**Gulp Fontmin:** Generate fonts from .ttf.
55
-
-**Gulp Imagemin:** Compress images.
56
-
-**Gulp Load plugins:** Load all the plugins once.
57
-
-**Gulp Newer:** On some tasks we want to do something only with the newer files.
58
-
-**Gulp Nodemon:** To launch the NodeJS application.
59
-
-**Gulp Noop:** Basic Noop but on stream.
60
-
-**Gulp Sass:** Compile Scss to CSS.
61
-
-**Gulp Sasslint:** Linting for SASS.
62
-
-**Gulp Sourcemaps:** Generate Sourcemaps when is necessary.
63
-
-**Gulp TSLint:** Linting for TypeScript.
64
-
-**Gulp Uglify:** Minify and obfuscate JavaScript.
65
-
-**Opn:** Open browser to see the preview.
66
-
-**Require all:** Load all gulp tasks once.
67
-
-**Yarn:** Instead of NPM.
48
+
On this branch we use:
49
+
-**Webpack:** Scripts tasks.
50
+
-**Gulp:** Styles and assets tasks.
68
51
69
52
**[⬆️ back to top](#quickstart)**
70
53
@@ -84,83 +67,66 @@ To run the tasks we have these three commands:
84
67
85
68
**[⬆️ back to top](#quickstart)**
86
69
87
-
## 🔮 Environments
88
-
On this project we have two environments:
89
-
-**Local:** Use this on your computer
90
-
-**Development:** Use this on your dev server
91
-
-**Production:** Use this on your production server
92
-
93
70
## ⛩️ Project structure
94
-
On this branch _(Basic)_the structure is:`
71
+
On this branch the structure is:`
95
72
```
96
-
./
97
-
│
98
-
├── app/
99
-
│ ├── client/
100
-
│ │ ├── assets/
101
-
│ │ │ ├── fonts/
102
-
│ │ │ │ └── OpenSans
103
-
│ │ │ │ ├── OpenSans-Regular.ttf
104
-
│ │ │ │ ├── ...
105
-
│ │ │ │ └── OpenSans-SemiboldItalic.ttf
106
-
│ │ │ │
107
-
│ │ │ └── images/
108
-
│ │ │ └── example.jpg
109
-
│ │
110
-
│ │ ├── js/
111
-
│ │ │ └── app.js
112
-
│ │ │
113
-
│ │ └── scss/
114
-
│ │ ├── base/
115
-
│ │ │ ├── mixins # Some mixins to use on base folder
116
-
│ │ │ ├── _fonts.scss # Load the fonts for your project
117
-
│ │ │ ├── _globals.scss # Global styles
118
-
│ │ │ ├── _states.scss # States classes, like is-hidden, is-visible...
119
-
│ │ │ ├── _utilities.scss # Utility classes, like u-mt-10@xs _(margin-top 10px on media screen xs)_
120
-
│ │ │ └── _variables.scss # Global variables of the project
121
-
│ │ │
122
-
│ │ ├── components/
123
-
│ │ │ └── _ck-site.scss # Example of BEM based component
124
-
│ │ │
125
-
│ │ ├── vendor/
126
-
│ │ │ └── _normalize.scss # Import and extend Normalize
127
-
│ │ │
128
-
│ │ └── index.html
129
-
│ │
130
-
│ ├── server/
131
-
│ │ ├── compiler/
132
-
│ │ │ ├── fonts/
133
-
│ │ │ │ └── compiler.controller.ts
134
-
│ │ │ │ └── compiler.service.ts
135
-
│ │ └── server.ts
136
-
│
137
-
├── dist/ # Distribution folder
138
-
│
139
-
├── tasks/ # Gulp tasks
140
-
│ ├── config/
141
-
│ │ ├── helpers.js # Helpers that useful for tasks
142
-
│ │ └── options.js # Internal operation to use with tasks
143
-
│ ├── rules/
144
-
│ │ ├── scripts.js # Create a bundle for JavaScript files
145
-
│ │ └── scripts-lint.js # Check linting of JavaScript files
146
-
│ ├── assets.js # Minify images and generate fonts
147
-
│ ├── clean.js # Clean distribution folder
148
-
│ ├── copy.js # Copy index.html to dist
149
-
│ ├── scripts-lint.js # Linting for JavaScript
150
-
│ ├── scss.js # Compile and compress SASS files when is necessary
151
-
│ ├── scss-lint.js # Linting for SASS
152
-
│ ├── serve.js # Open a browser with the preview of the project
153
-
│ ├── ts.js # Transpile and compress TypeScript depending of the environment
0 commit comments