biobulkbende
/
biobulkbende.org
mirror of https://github.com/biobulkbende/biobulkbende.org.git
0
0
Fork 0
Code Issues Projects Releases Wiki Activity

adjusted md

This commit is contained in:
Tancre 2021-05-26 11:59:11 +02:00
parent e282b3c3c9
commit 4ed5c56cf9
1 changed files with 12 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -14,54 +14,47 @@ Our public website made by members!
## Structure
The website is served from the folder /app
The website is served from the folder `/app`
The folder /assets is only for developement while the folde /bundle contains the files linked to index.html and /en/index.html
The folder `/assets` is only for developement while the folde `/bundle` contains the files linked to `index.html` and `/en/index.html`
### Html
There are two pages:
- index.html (Dutch)
- /en/index.html (English)
- `index.html` (Dutch)
- `/en/index.html` (English)
Changes to the text can be done directly to these files without having to run any automation.
### (S)CSS
The CSS files to be changed are stored in /assets/scss which contains:
* /base (global CSS declarations)
* /modules (specific CSS declarations)
- /base (global CSS declarations)
- /modules (specific CSS declarations)
The CSS is written in SCSS and after changing it must be compiled and bundled togheter.
The command `gulp watch` runs automation and make sure that when you save the change in atuomatic everything is compiled and bundled.
The final file is stored in /bundle/styles and provide the CSS to index.html and /en/index.html
The final file is stored in `/bundle/styles` and provide the CSS to `index.html` and `/en/index.html`.
### JS
The JS file to be changed are stored in assets/js/modules
The JS file to be changed are stored in `assets/js/modules`
The JS is writted in ES6 and after changing it must be compiled in ES5 and bundled togheter.
The command `gulp watch` runs automation and make sure that when you save the change in atuomatic everything is compiled and bundled.
The final file is stored in /bundle/scripts and provide the JS to index.html and /en/index.html.
The final file is stored in `/bundle/scripts` and provide the JS to `index.html` and `/en/index.html`.
### Media
The media are stored in /assets/media containing:
The media are stored in `/assets/media` containing:
* Icons
* Fonts
* Images
Icons are compressed in a sprite through the command `gulp icons`. (This is complicated as it generates a single sprite with all the icons togheter and a CSS which points at the right icon in the sprite). After this command automation for the CSS must be runned.
Images are minified through the command `gulp images`.
All the media are copied with the command `gulp copyMediaInBundle` (it also minified the images) into the folder `/bundle/media` which provide the media to `index.html` and `/en/index.html`.
All the media are copied with the command `gulp copyMediaInBundle` (it also minified the images) into the folder /bundle/media which provide the media to index.html and /en/index.html.
If you want to change an Image you have to put it in /assets/media/images and run `gulp copyMediaInBundle`. The html must refer to the image that has been copied and minified in /bundle/media/images.
If you want to change an Image you have to put it in `/assets/media/images` and run `gulp copyMediaInBundle`. The html must refer to the image that has been copied and minified in `/bundle/media/images`.
### Video