Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnftitor/webpacktemplate
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!
https://github.com/johnftitor/webpacktemplate
template webpack
Last synced: about 4 hours ago
JSON representation
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!
- Host: GitHub
- URL: https://github.com/johnftitor/webpacktemplate
- Owner: JohnFTitor
- Created: 2022-01-11T14:39:31.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-04T22:17:06.000Z (almost 3 years ago)
- Last Synced: 2024-11-05T23:43:37.523Z (about 2 months ago)
- Topics: template, webpack
- Language: SCSS
- Homepage:
- Size: 8.42 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project Title
> Project headline description
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 clone```https://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](https://github.com/microverseinc/linters-config/tree/master/html-css-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**
- GitHub: [@JohnFTitor](https://github.com/JohnFTitor)
- Twitter: [@johnftitor](https://twitter.com/johnftitor)
- LinkedIn: [Andres](https://www.linkedin.com/in/andresarroyavenaranjo/?locale=en_US)
## Acknowledgments
## Show your support
Give a ⭐️ if you like this project!
## 📝 License
This project is [MIT](./MIT.md) licensed.