Project headline description
Project Description
Tecnologies used
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
You need to make sure to have installed the latest version of Node.js and npm on your computer.
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.
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
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.
You're free to use this project however you like it for educational purposes. Just keep in mind the acknowledgment described below
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.
The deployment can be found in the Github Pages of this repository or through the link provided above
π€ AndrΓ©s Felipe Arroyave Naranjo
- GitHub: @JohnFTitor
- Twitter: @johnftitor
- LinkedIn: Andres
Give a βοΈ if you like this project!
This project is MIT licensed.