https://github.com/alejandroq12/webpack-template
"This a webpack template that I will use for future projects"
https://github.com/alejandroq12/webpack-template
webpack webpack-boilerplate
Last synced: 9 months ago
JSON representation
"This a webpack template that I will use for future projects"
- Host: GitHub
- URL: https://github.com/alejandroq12/webpack-template
- Owner: Alejandroq12
- Created: 2022-12-29T02:48:45.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-29T18:57:56.000Z (about 3 years ago)
- Last Synced: 2025-04-04T05:51:10.986Z (about 1 year ago)
- Topics: webpack, webpack-boilerplate
- Language: JavaScript
- Homepage:
- Size: 600 KB
- Stars: 13
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Webpack template
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
"This a webpack template that I will use for future projects"
Client
- **This is webpack template**
Live demo is no available because this one is just a template.
To get a local copy up and running, follow these steps:
### Prerequisites
To work with this project, you need:
1. A modern web browser to view the website (e.g., Google Chrome, Firefox, Safari, or Microsoft Edge).
2. A code editor for editing the code, such as Visual Studio Code, Atom, or Sublime Text.
3. Node.js installed on your machine. You can download the latest version [here](https://nodejs.org/en/download/).
4. npm (Node Package Manager) installed, which comes bundled with Node.js.
5. After cloning the project, make sure to run npm install to install all the necessary dependencies, including Luxon and linters, specified in the package.json file.
### Setup
Clone this repository to your desired folder:
1. Clone it using your terminal:
```
git clone https://github.com/Alejandroq12/webpack-template.git
```
2. If the previous method does not work you may also download the repo as a .zip file and once you decompress the .zip file you are ready to use it.
Important: do not forget to clone the repo in the correct folder, probably you will use the following commands to achieve that in your terminal:
1. To navigate a certain folder:
```
cd
```
2. To navigate to the previous folder:
```
cd ..
```
### Install
Install this project with:
1. Complete the following steps:
```
npm init -y
npm install
```
3. If you run npm install, remember to create a .gitignore file to prevent the node_modules folder from being uploaded to GitHub:
```
.gitignore
node_modules/
```
### Usage
To use this project locally on your computer, follow these steps:
1. Clone the repository or download the project files.
2. Navigate to the project directory where the files are located.
3. Go to the terminal and run:
-- This command will run the development mode:
```
npm start
```
-- This command will run the production mode:
```
npm run build
```
The website should now be displayed in your browser, and you can interact with the application as intended.
### Run tests
1. I did not include linters because this ons is just a template.
### Deployment
You can deploy this project using GitHub pages:
1. Log in to your GitHub account and navigate to the repository that contains your website files.
2. Make sure that your website files are located in the main branch and in the root directory of the repository.
3. If your website is not already live, make sure that the index.html file is the main page of your website.
4. Click on the "Settings" tab in your repository.
5. Scroll down to the "GitHub Pages" section.
6. In the "Source" dropdown menu, select the branch where your website files are located. For a simple website with only HTML and CSS, this is typically the main branch.
7. In the "Path" field, make sure that the root directory is specified (i.e., "/").
8. Click "Save" to generate your website.
9. Wait a few minutes for GitHub to build and deploy your website.
10. Once the website is deployed, visit the GitHub Pages URL to view your site.
👤 **Julio Quezada**
- GitHub: [Alejandroq12](https://github.com/Alejandroq12)
- Twitter: [@JulioAle54](https://twitter.com/JulioAle54)
- LinkedIn: [Julio Quezada](https://www.linkedin.com/in/quezadajulio/)
- [ ] **You can addapt this template to different projects**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project please give a star.
Thanks in advance.
I would like to thank Wes Bos because I learned how to implement flexbox with his free tutorial:
- Wes Bos: [Wes Bos](https://flexbox.io/)
- **Can I use this template?**
- Yes! you can use it, copy it and adjust it to your needs.
This project is [MIT](./MIT.md) licensed.