https://github.com/estete9/webpack-template

A template repository to clone a basic project already setup with Webpack
https://github.com/estete9/webpack-template

Last synced: about 1 month ago
JSON representation

A template repository to clone a basic project already setup with Webpack

• Host: GitHub
• URL: https://github.com/estete9/webpack-template
• Owner: Estete9
• Created: 2023-08-15T12:59:32.000Z (over 1 year ago)
• Default Branch: dev
• Last Pushed: 2023-09-06T15:31:09.000Z (over 1 year ago)
• Last Synced: 2024-12-31T18:34:45.637Z (about 1 month ago)
• Language: JavaScript
• Size: 1.76 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




  

  


  
YOUR-PROJECT-NAME-HERE




# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

- [💻 Getting Started](#getting-started)

  - [Prerequisites](#prerequisites)

  - [Setup](#setup)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 WEBPACK TEMPLATE 

**WEBPACK TEMPLATE** This template is focused on being a base project using Webpack and all the core libraries needed.

## 🛠 Built With 

### Tech Stack 

  Client

  


    
HTML

    
CSS (including responsive design)

    
JavaScript for menu functionality

    
Webpack

  


Database

  


    
PostgreSQL

  


### Key Features 

- **[Responsive design for mobile and desktop]**

- **[Menu functionality using JavaScript]**

- **[Use of modules and libraries]**

(back to top)


## 💻 Getting Started 

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

### Prerequisites

To run this project you need:

- VSCode

- npm

- Node

### Setup

Make sure you have VSCode, npm, and Node installed

### Install

In the root folder, run the script `npm install` to install all the libraries necessary.

### Usage

#### Webpack

Run the scripts:

- Each time before running your page use `npm run build` so webpack creates the necessary files in the dist folder

- `npm run watch-webpack` to only have Webpack watch your files or

- `npm run watch` to watch the tests and Webpack changes

#### Live Demo

- Run the script `npm run start` to see a live version of the project

### Run tests

Use the scripts: 

- `npm run watch-jest` to only watch your tests with Jest or 

- `npm run watch` to watch the tests and Webpack changes

(back to top)


## 👥 Authors 

👤 **Esteban Palacios**

- GitHub: [@Estete9](https://github.com/Estete9)

- Twitter: [@NaughTban](https://twitter.com/NaughTban)

- LinkedIn: [Esteban Palacios](https://www.linkedin.com/in/esteban-palacios-5030a772/)

(back to top)


## 🔭 Future Features 

- **Run `npm run build` at the same time the `npm run start` so Webpack automatically creates the necessary folders before starting the page**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page UPDATE URL HERE](https://github.com/Estete9/webpack-template/issues).

(back to top)


## ⭐️ Show your support 

If you like this project remember to star and share it 🥳️

(back to top)


## 🙏 Acknowledgments 

- ACKNOWLEDGMENTS TO CREATIVE LICENSE AND OTHERS

## 📝 License 

This project is [MIT](./MIT.md)-licensed.

(back to top)