- 📖 About the Project
- 💻 Getting Started
- Loom-Walkthrough
- 👥 Authors
- 🤝 Contributing
- ⭐️ Show your support -- 🙏 Acknowledgements
- ❓ FAQ
- 📝 License
[Portfolio-site] This is a simple portfolio site, that is simple and yet elegant.
-shows my portfolio -has a contact form -has a download button for my resume -it's a responsive site
- [Demo on what is linters and how it works]
Creating your first "Hello-microverse" project
To get a local copy up and running, follow these steps.
In order to run this project you need:
-A Git hub account
-Node JS
-Visual Studio Code or any other code editor of your preference
-web browser
Clone this repository to your desired folder:
You can find linters for most of the programming languages, e.g. Rubocop for Ruby or ESLint for JavaScript.
Also, there are many ways you can integrate a linter in your workflow:
-text editor plugin
-GitHub Actions
-GitHub apps
Note: The npm package manager is going to create a node_modules directory to install all of your dependencies. You shouldn't commit that directory. To avoid that, you can create a .gitignore file and add node_modules to it:
node_modules/
This is a customizable linting tool that helps you improve your site's accessibility, speed, cross-browser compatibility, and more by checking your code for best practices and common errors.
NOTE: If you are using Windows, make sure you initialize npm to create package.json file.
npm init -y
- Run
how to use npm: (https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
npm install --save-dev hint@7.x - Copy .hintrc to the root directory of your project.
- Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.
- If you think that change is necessary - open a Pull Request in this repository and let your code reviewer know about it.
- Run
npx hint . - Fix validation errors.
A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.
- Run
npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x not sure how to use npm? Read this.
-
Copy .stylelintrc.json to the root directory of your project.
-
Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.
If you think that change is necessary - open a Pull Request in this repository and let your code reviewer know about it. 4. Run npx stylelint "*/.{css,scss}" on the root of your directory of your project.
-
Fix linter errors.
-
IMPORTANT NOTE: feel free to research auto-correct options for Stylelint if you get a flood of errors but keep in mind that correcting style errors manually will help you to make a habit of writing a clean code!
- Loom walkthrough: (https://www.loom.com/share/5d3467a6b52549a5917f7f6291f29aba)
👤 Author
- GitHub: (https://github.com/othniel2471)
- Twitter: (https://twitter.com/@Oomaidu)
- LinkedIn: (https://www.linkedin.com/in/othniel-omaidu-3350a9164)
- [hamburger-menu]
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
If you like this project, kindly leave a comment below and share it with someone who enjoys coding! And also give it star, and follow me on github for more. Keep going!
I would like to thank Microverse for helping out with this project
This project is MIT licensed.