Skip to content
This repository has been archived by the owner on Jun 20, 2020. It is now read-only.

Latest commit

 

History

History
93 lines (68 loc) · 3.89 KB

README.md

File metadata and controls

93 lines (68 loc) · 3.89 KB
Raw

BrowserStack Status Greenkeeper badge Build Status devDependencies Status

Welcome to the website of the future!

This website page template includes:

  • Service Worker - Native App (Android and iOS), Offline, Push Notifications => a.k.a PWA!
  • HTML, CSS, JavaScript compressed and bundled
  • Browserify, use npm packages!
  • Client-side routes
  • "Font Awesome 5" web icons
  • Continuous Integration for GitLab Pages
  • PostCSS
  • Bootstrap 4 grid CSS
  • "Canonical.css", a CSS reset by Marxo (Marko Kazhich)
  • AVA Tests
  • NYC Code Coverage
  • WebdriverIO
  • Sitemap.xml Generator
  • SEO Template

Everything is already setup. Just write your code, run npm run build, start the app and see the result!

Installation (WIP)

Not yet implemented!

npm i -g fe-template

Usage

fe-template my-website

Manual installation and usage

  1. Clone the repo.
git clone https://github.com/VladimirDev93/website-template.git
  1. Open the terminal in website-template directory, and enter the following command first.
npm i
  1. Run the following command in your terminal, in order to configure ESLint file.
npm run eslint
  1. Navigate to src folder and edit your files from there. Build the application in order to see the result.
npm run build
  1. Navigate to the public folder and run this command to see the results.
npm start

If for some reason local-web-server is having issues, install the module globally, then run the following command:

ws --spa index.html

Example

This is an example on how you can use the popular Visual Studio Code editor to develop your website. On the left terminal you can run the npm run build command every time you make changes, and on the right terminal you can watch if the error occurs with your local development server.

img

Licence

MIT License

Copyright (c) 2018 Vladimir Jovanović

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

FOSSA Status