mirror of
https://github.com/biobulkbende/biobulkbende.org.git
synced 2024-12-25 12:45:23 +00:00
more info on the website and how it works
This commit is contained in:
parent
6f442efb09
commit
e282b3c3c9
55
README.md
55
README.md
@ -5,7 +5,6 @@
|
|||||||
> https://biobulkbende.org
|
> https://biobulkbende.org
|
||||||
|
|
||||||
Our public website made by members!
|
Our public website made by members!
|
||||||
|
|
||||||
## Hacking
|
## Hacking
|
||||||
|
|
||||||
- Make sure you have installed git, node.js and npm
|
- Make sure you have installed git, node.js and npm
|
||||||
@ -13,6 +12,60 @@ Our public website made by members!
|
|||||||
- From within the folder install all packages: `npm install`
|
- From within the folder install all packages: `npm install`
|
||||||
- Run gulp for automation: `gulp watch`
|
- Run gulp for automation: `gulp watch`
|
||||||
|
|
||||||
|
## Structure
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
### Html
|
||||||
|
|
||||||
|
There are two pages:
|
||||||
|
- 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)
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
### JS
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Media
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
The video is stored on vimeo.
|
||||||
## Deployment
|
## Deployment
|
||||||
|
|
||||||
Just push commits and our [CD config](https://drone.autonomic.zone/biobulkbende/biobulkbende.org) will deploy the website.
|
Just push commits and our [CD config](https://drone.autonomic.zone/biobulkbende/biobulkbende.org) will deploy the website.
|
||||||
|
@ -148,6 +148,7 @@ function copyFonts() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
exports.watch = watch;
|
exports.watch = watch;
|
||||||
|
exports.images = imagesTask;
|
||||||
exports.icons = series(
|
exports.icons = series(
|
||||||
beginClean,
|
beginClean,
|
||||||
createSprite,
|
createSprite,
|
||||||
@ -155,7 +156,7 @@ exports.icons = series(
|
|||||||
copySpriteCSS,
|
copySpriteCSS,
|
||||||
endClean
|
endClean
|
||||||
);
|
);
|
||||||
exports.images = imagesTask;
|
|
||||||
|
|
||||||
exports.copyMediaInBundle = series(
|
exports.copyMediaInBundle = series(
|
||||||
copySpriteGraphic,
|
copySpriteGraphic,
|
||||||
|
Loading…
Reference in New Issue
Block a user