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
+54-10Lines changed: 54 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -106,16 +106,17 @@ The project is coded using a simple and intuitive structure presented bellow:
106
106
| page-500.html # Error 404 page
107
107
|*.html # All other HTML pages
108
108
|
109
-
|-- authentication/ # Handles auth routes (login and register)
109
+
|-- apps/
110
+
||-- authentication/ # Handles auth routes (login and register)
111
+
|||
112
+
|||-- urls.py # Define authentication routes
113
+
|||-- views.py # Handles login and registration
114
+
|||-- forms.py # Define auth forms
110
115
||
111
-
||-- urls.py # Define authentication routes
112
-
||-- views.py # Handles login and registration
113
-
||-- forms.py # Define auth forms
114
-
|
115
-
|-- app/ # A simple app that serve HTML files
116
-
||
117
-
||-- views.py # Serve HTML pages for authenticated users
118
-
||-- urls.py # Define some super simple routes
116
+
||-- app/ # A simple app that serve HTML files
117
+
||
118
+
||-- views.py # Serve HTML pages for authenticated users
119
+
||-- urls.py # Define some super simple routes
119
120
|
120
121
|-- requirements.txt # Development modules - SQLite storage
121
122
|
@@ -136,6 +137,49 @@ The project is coded using a simple and intuitive structure presented bellow:
136
137
137
138
<br />
138
139
140
+
## Recompile CSS
141
+
142
+
To recompile SCSS files, follow this setup:
143
+
144
+
<br />
145
+
146
+
**Step #1** - Install tools
147
+
148
+
-[NodeJS](https://nodejs.org/en/) 12.x or higher
149
+
-[Gulp](https://gulpjs.com/) - globally
150
+
-`npm install -g gulp-cli`
151
+
-[Yarn](https://yarnpkg.com/) (optional)
152
+
153
+
<br />
154
+
155
+
**Step #2** - Change the working directory to `assets` folder
156
+
157
+
```bash
158
+
$ cd core/static/assets
159
+
```
160
+
161
+
<br />
162
+
163
+
**Step #3** - Install modules (this will create a classic `node_modules` directory)
164
+
165
+
```bash
166
+
$ npm install
167
+
// OR
168
+
$ yarn
169
+
```
170
+
171
+
<br />
172
+
173
+
**Step #4** - Edit & Recompile SCSS files
174
+
175
+
```bash
176
+
$ gulp scss
177
+
```
178
+
179
+
The generated file is saved in `static/assets/css` directory.
180
+
181
+
<br />
182
+
139
183
## Deployment
140
184
141
185
The app is provided with a basic configuration to be executed in [Docker](https://www.docker.com/), [Gunicorn](https://gunicorn.org/), and [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/).
0 commit comments