Code Monkey home page Code Monkey logo

webpacktemplate's Introduction

Webpack Template

A template to use [email protected] to build ES6 code into ES5. This template includes Bootstrap 4.3.1 and jQuery 3.4.1

Reccomendations

  • Use VS Code to edit the project
  • Use the integrated terminal inside of VS Code to run commands (accessed by clicking the Terminal tab and then New Terminal)
    • If you open the project folder in VS Code (the top level folder with the package.json file), the integrated terminal will start in the project folder so you don't need to cd

Installation

  1. Install NodeJS if you do not already have it (LTS version recommended)
  2. Clone or download the repo
  3. Open a terminal and cd to this folder
    • For MacOS, open Terminal
    • For Windows, open Powershell or Command Prompt
    • Alternatively, use the integrated terminal in VS Code
  4. Run the command npm install
    • If you have windows, you may need to have Python2.X installed to run this command

Usage

  1. Build the project
    • Run the command npm run build to compile the project one time
    • Run the command npm run watch to automatically recompile the project every time you save
  2. Open ./dist/index.html in your web browser

Included Libraries

Bootstrap

You can use css classes from Bootstrap 4.3.1 anywhere in the project

jQuery

You can use functions from jQuery 3.4.1 anywhere in the JavaScript code

ESLint

ESLint is a library that helps to maintain a standard code formatting and is used in many corporate settings. I have provided an example lint file that enforces certain whitespace and syntax rules on the code.

  • To see how your code compares to the lint rules, run the command npm run lint -s
  • To automatically fix some types of lint errors, run npm run lint -s -- --fix
  • There is also an ESLint VS Code Extension that will show lint errors in the code editor

License

MIT

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.