https://github.com/rileymanda/hello-microverse
https://github.com/rileymanda/hello-microverse
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rileymanda/hello-microverse
- Owner: RileyManda
- Created: 2023-04-25T11:38:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-25T18:09:19.000Z (over 3 years ago)
- Last Synced: 2025-03-14T00:16:02.139Z (over 1 year ago)
- Language: HTML
- Size: 13.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
-- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
**[Hello-microverse]** this was mini-projects that upkill to create a feature branch and test linters in order to have professional-looking code.
Javascript runtime environment
Version control
Creating your first "Hello-microverse" project
To get a local copy up and running, follow these steps.
### Prerequisites
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
### Setup
Clone this repository to your desired folder:
Advantages of Linters:
1: improves readability-it will be easy to read and make adjustment if required easily.
2:removes silly errors before execution and code review.
3:Makes code look like written by a single person.
4:Spreads awareness and ownership over code quality
5:Having more secure and performant code.
## Install Linters
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
## Set up Linters
**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:
# .gitignore
node_modules/
## Web Hint
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
```
1. Run
```
npm install --save-dev hint@7.x
```
_how to use npm: (https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)._
2. Copy [.hintrc](.hintrc) to the root directory of your project.
3. **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](../README.md#contributing) and let your code reviewer know about it.
4. Run
```
npx hint .
```
5. Fix validation errors.
### [Stylelint](https://stylelint.io/)
A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.
1. 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.
2. Copy .stylelintrc.json to the root directory of your project.
3. **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.
5. Fix linter errors.
6. **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!
👤 **Riley Manda**
- GitHub: [@RileyManda](https://github.com/RileyManda)
- Twitter: [@rilecodez](https://twitter.com/rilecodez)
- LinkedIn: [rileymanda](https://www.linkedin.com/in/rileymanda/)
> Describe 1 - 3 features you will add to the project.
- [ ] **[new_feature_1]**
This project will not have any additional features.
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project, kindly leave a comment below and share it with someone who enjoys coding! Coding is all about continuous learning and allowing yourself to be a beginner. Keep going!
I'm grateful to microverse for giving me every opportunity to grow into my full potential
- **[Question_1]**
Do I have to use the vs code specifically?
- [Answer_1]
You can use any code editor of your chose.
- **[Question_2]**
Where can I download node JS for installation?
- [Answer_2]
Node Js can be downloaded here- https://nodejs.org/en/download/
This project is [MIT](https://choosealicense.com/licenses/mit/) licensed.