biobulkbende/biobulkbende.org
0
0
Fork 0
mirror of https://github.com/biobulkbende/biobulkbende.org.git synced 2024-12-25 12:45:23 +00:00
Code Issues Projects Releases Wiki Activity

README pass & new lock file (node v14)

Browse Source
This commit is contained in:
decentral1se 2023-02-27 20:15:08 +01:00
parent f3a81238fd
commit ddd86ad045
No known key found for this signature in database
GPG Key ID: 03789458B3D0C410
2 changed files with 3265 additions and 17875 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -1,48 +1,53 @@
# biobulkbende.org
> https://biobulkbende.org
> [biobulkbende.org](https://biobulkbende.org)
Our public website made by members.
## Hacking
- Make sure you have installed git, node.js and npm
- Make sure you have installed `git`, `node` (v14 LTS) and `npm`
- Clone this repo: `git clone https://github.com/biobulkbende/biobulkbende.org`
- From within the folder install all packages: `npm install`
- Run gulp for automation: `gulp watch`
## Structure
The website is served from the folder `/app`
The website is served from the folder `/app`. The folder `/assets` is only for
development while the folder `/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
### 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.
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 CSS is written in SCSS and after changing it must be compiled and bundled
together. The command `gulp watch` runs automation and make sure that when you
save the change in automatic 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`.
The JS files to be changed are stored in `assets/js/modules`. The JS is written
in ES6 and after changing it must be compiled in ES5 and bundled together. The
command `gulp watch` runs automation and make sure that when you save the
change in automatic 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
@ -52,11 +57,19 @@ The media are stored in `/assets/media` containing:
- 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`.
Icons are compressed in a sprite through the command `gulp icons`. (This is
complicated as it generates a single sprite with all the icons together and a
CSS which points at the right icon in the sprite). After this command
automation for the CSS must be run.
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`.
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

21087
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff