Git Product home page Git Product logo

johnftitor / webpacktemplate Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 8.62 MB

This template sets up a basic file structure for webpack projects with SCSS loader, jest tests, and GitHub pages deploy feature. It also includes a pull request template that you can edit to your liking. Linters are also included as dependencies. Feel free to use this template for any of your projects!

JavaScript 23.50% HTML 7.17% SCSS 69.33%
webpack template

webpacktemplate's Introduction

Project Title

Project headline description

Preview

Project Description

Built With

Tecnologies used

Live Demo

Live Demo Link

Getting Started

To get a local copy up and running follow these simple example steps.

  • Clone this repository with git clonehttps://github.com/username/projectname.git using your terminal or command line.
  • Change to the project directory by entering :
    cd projectname in the terminal

Prerequisites

You need to make sure to have installed the latest version of Node.js and npm on your computer.

Setup

You can clone this repository or simply download the files as a .zip If you want to set up a personal repository based on this one, you can as well fork it.

Install

After clone it and before working on it, you have to run npm install so that all the dependencies of the project get downloaded in your pc locally. Such dependencies include webpack and linters checks, for which you have to either generate your own config file or get one.

Note: If you're a Microverse's Student, you should use the config files provided by the program. Linters Config HTML/CSS and JS

About WebPack deploy to Github Pages

The dependencies and configuration are all set to deploy the dist folder to a gh-pages branch. The only thing you need to do is to change the publicPath inside webpack.config.js to match the one of your project.

Usage

You're free to use this project however you like it for educational purposes. Just keep in mind the acknowledgment described below

Run linters checks

Linter Checks are automatically run with Github actions when there's a pull request. If you want to run them locally, remember to have the config file in the root of the local project.

Deployment

The deployment can be found in the Github Pages of this repository or through the link provided above

Authors

πŸ‘€ AndrΓ©s Felipe Arroyave Naranjo

Acknowledgments

Show your support

Give a ⭐️ if you like this project!

πŸ“ License

This project is MIT licensed.

webpacktemplate's People

Contributors

johnftitor avatar

Stargazers

Mar Bautista avatar

Watchers

 avatar

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.