lars-derichter / website-template

Project Template voor websites (HTML/CSS/Javascript) in Webontwikkeling en Netwerkbeheer aan het Scheppersinstituut Deurne & Antwerpen

Website template

Project template voor websites (HTML/CSS/JavaScript) in Webontwikkeling en Netwerkbeheer aan het Scheppersinstituut Deurne & Antwerpen

Je kan deze template gebruiken als startpunt voor al je 'platte' websites die geen back-end nodig hebben. Zo voldoe je moeiteloos aan een aantal belangrijke 'Best Practices' en wordt je text editor geconfigureerd volgens onze afspraken.

De template installeren

Vereisten

• Voor een aantal paketten heb je nodejs nodig. Volg de link en installeer het juiste pakket voor je systeem.
• Je hebt JavaScript Standard Style nodig en Stylelint nodig. Voer het volgende commando in je nodejs command line in:

npm install -g standard stylelint stylefmt

• Om de standaard configuraties te kunnen gebruiken, voer je dit commando in je nodejs command line in:

npm install stylelint-order stylelint-config-standard stylelint-config-idiomatic-order

• Je moet een degelijke, moderne text editor gebruiken. Wij gebruiken Atom met minimaal de volgende plugins of packages geïnstalleerd:
  • atom-beautify met Beautify on Save geactiveerd voor HTML, JSON en Markdown. Voor Markdown selecteer je Remark als Default Beautifier. Voor JavaScript selecteer je Disable Beautifying Language.
  • atom-standard-formatter en activeer Format On Save in de package settings.
  • stylefmt en activeer Format on Save in de package settings.
  • editorconfig
  • linter
  • linter-htmlhint
  • linter-stylelint vink Disable when no config file is found uit en selecteer Use standard.
  • linter-js-standard
  • standardjs-snippets
• Als je je code onder versiecontrole wil plaatsen, heb je git nodig de makkelijkste manier om git te gebruiken op je systeem is met Github Desktop.
• De eenvoudigste manier om je website gratis te publiceren is ook via Github.

De template folder installeren op je computer

De eenvoudigste manier om deze code te gebruiken is het zip-bestand downloaden en uitpakken:

1. Download het zip-bestand met de laatste versie.
2. Pak het zip-bestand uit naar je werkmap en geef de uitgepakte map een duidelijke naam.
3. [TODO: gebruik een npm install script om README om te vormen]
4. Verwijder het bestand README.md en hernoem README.md.template naar README.md.
5. Vul je nieuwe README.md bestand aan met de gegevens voor je project.

De template gebruiken

[TODO]

1. Vervang de verscheiden favicons door afbeeldingen van hetzelfde formaat. FAV-ICO-MATIC kan een hele hulp zijn. Hier is de ‘obsessive setting’ gebruikt.

Je code onder versiecontrole plaatsen (met git en Github)

[TODO]

Checklist voor publicatie

[TODO]

Je website publiceren (via Github)

[TODO]

Referenties

• EditorConfig gebruiken we om de standaard afspraken over indents, character sets, newlines … te forceren.
• JS Beautify gebruiken we voor HTML en inline CSS/JavaScript.
• JavaScript Standard Style is de moderne manier om JavaScript te schrijven.

Meewerken aan de template

[TODO]

Versies

We gebruiken SemVer voor versienummers. Bekijk de tags in deze repository voor de beschikbare versies.

Changelog

[TODO]

Auteurs

• Lars De Richter - Webontwikkeling & Netwerkbeheer aan het Scheppersinstituut Antwerpen

Licentie

Dit project is beschikbaar onder de MIT licentie - zie het LICENSE bestand.

Dank

[TODO]