nuxt-starter-template
nuxt-starter-template copied to clipboard
Template for basic static site generated marketing website
nuxt-starter-template
NUXT Template for static site generated marketing website
Features & Ready set up Built in
- Responsive Images via NUXT Optimized Images
- Fancyapps UI (Licence needed)
- Manifest & Favicon Icon Generation
- Automatic Sitemap Generation
- Bootstrap
- Countup.js
- Fantasticon
- Mail Spam Protection
- PHP Contact Form
- ~~PurgeCSS~~
- Responsive Slideout Menu
- Good Lighthouse Audit ( Performance 90+, Accessibility 100, Best Practices 100, SEO 100)
- Opt-In Cookie Banner
- Modal Windows with route change
Build Setup
# install dependencies
$ npm install
# serve with hot reload at localhost:3000
$ npm run dev
# build for production and launch server
$ npm run build
$ npm run start
# generate static project
$ npm run generate
For detailed explanation on how things work, check out Nuxt.js docs.
Configuration
General
nuxt.config.jsconfig/infos.jsonfor contact information that will be used in different places site-widemenus.jsonto generate main menu, footer menu and social menu
Image-Sizes
- Check
compontents/lib/ImageSet.vueto adjust image-sizes for your customsrc-set
Webfonts
- Add preconnect URL for external Webfonts to
nuxt.config.jsinhead.link - Add Custom Families to
nuxt.config.jsinwebfontloader(see: nuxt-webfontloader) - Optional: Use local-webfont to download webfonts css and add
display: swapto css file (see:css/_font.scss)
Favicon & Manifest
- Replace
static/favicon.svg - Change
config/faviconDescription.jsonor generate new one for nuxt-rfg-icon favicon.icowill be generated throughnuxt-rfg-icon
Sitemap
- Change settings in
nuxt.config.js - Use
sitemap.routesto overwrite priorities or add more URLs
Contact Form
- Change Message Body, Field names and email address in
static/mailer.php
Fontasticon
- Generates Icon Font from
assets/icons/*.svgtostatic/fonts/icon-font.*. - Uses
config/fontasticon.jsto map decimal unicode characters for the font. - Generates CSS Classes for different icons to
css/_icons.scssfrom template placed inhelpers/icon-font-template.hbs - Generates list of Icons to
helpers/icons.json. Used inicons.vuepage to show all icons. Seepackage.jsonscripts key andconfig/fontasticon.jsfor options.
npm run icons
Cookie Message
- Every key in
cookieGroupsinconfig/cookieMessage.jsonwill be a group of services in the message. See the example to create new groups. - Use the store service to execute code when something is enabled.
- see
privacy.vuefor related privacy informations
ToDo
- Cookie Message as extra component: Work in progress. Help wanted!
Credits
Thanks to GigaHierz for helping prepare this repo and her feedback!
Thanks to HF Media for the stunning placeholder video.
Thanks to myself for the placeholder images.