One paragraph statement about the project.
| Additional description about the project and its features.
- Languages: HTML, CSS
- Frameworks: N/A
- Technologies used: GIT, GITHUB, LINTERS
This is an example of how you may give instructions on setting up your project locally. Modify this file to match your project, remove sections that don't apply. For example: delete the testing section if the currect project doesn't require testing.
To get a local copy up and running follow these simple example steps.
- npm (node package manager) - to be able to install packages locally.
- A github Account - to be able to use github actions.
- Open the terminal.
- Run
cd \path\to\where\you\want\your\local\copy
- Clone the repo
- Run
git clone [email protected]:MrRamoun/README.git
- Run
cd README/
- Run
-
install Webhint linter
- Run
npm install --save-dev [email protected]
- Run
-
install Stylelint linter
- Run
npm install --save-dev [email protected] [email protected] [email protected] [email protected]
- Run
-
install ESLint linter
- Run
npm install --save-dev [email protected] [email protected] [email protected] [email protected]
- Run
-
install gulp
- Run
touch gulpfile.js
- Run
npm install gulp --save-dev
- Run
npm install gulp-autoprefixer --save-dev
- Run
- run Webhint linter
- Run
npx hint .
on the root of your directory of your project.
- Run
- run Stylelint linter
- Run
npx stylelint "**/*.{css,scss}"
on the root of your directory of your project.
- Run
- run ESLint linter
- Run
npx eslint .
on the root of your directory of your project.
- Run
- run gulp
- Run
gulp <name-of-task>
on the root of your directory of your project.
- Run
👤 Ramoun
Platform | Badge |
---|---|
GitHub | |
LinkdIn |
👤 Author2
- GitHub: @githubhandle
- Twitter: @twitterhandle
- LinkedIn: LinkedIn
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
Give a ⭐️ if you like this project!
- Hat tip to anyone whose code was used
- Inspiration
- etc
This project is MIT licensed.