rubydevi/Hello-Microverse

📗 Table of Contents

• 📖 About the Project
  • Tech Stack
  • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Hello Microverse

Hello Microverse is a project I completed on Day 2 of Module 1 as a student in Microverse. This project was created to practice utilizing linters, GitHub Flow, and requesting code reviews.

As a summary, Hello Microverse is a simple project that includes a basic HTML structure and a CSS stylesheet. The HTML and CSS code are both validated with linters to ensure code quality and consistency. The project follows the GitHub Flow, with branches for features, bug fixes, and pull requests for code review.

Overall, Hello Microverse provided a great introduction to the Microverse program and allowed me to practice essential skills for software development.

Tech Stack

Client

• HTML and CSS

Key Features

• Configured Linters
• Added an HTML File
• Added a CSS file

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

1. git
2. VS Code or any code editor
3. NPM intalled

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:rubydevi/Hello-Microverse.git
  cd Hello-Microverse

Install

Install this project with:

Weblint

1. Run this code:

 npm install --save-dev hint@7.x

2. Don't forget to copy .hintrc to the root directory of your project.

3. Run this code after you write your html code.

 npm hint .

4. It will show you errors, fix all the errors shown.

Stylelint

1. Run this code:

 npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x

2. Don't forget to copy .stylelintrc.json to the root directory of your project.

3. Run this code after you write your html code.

 npx stylelint "**/*.{css,scss}"

4. It will show you errors, fix all the errors shown.

Usage

To run this project in the browser, simply open the index.html file in your preferred browser.

Run tests

To run tests, run the following command:

 npm hint .

(back to top)

👥 Authors

👤 Chongtham Ruby Devi

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Integration with a continuous integration/continuous deployment (CI/CD) pipeline
• The addition of linters for other programming languages such as JavaScript
• Implementation of an automatic code formatter

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project please leave a star, I'd really appreciate it.

(back to top)

Acknowledgments

• I'd like to thank Microverse for this wonderful README template.

📝 License

This project is MIT licensed.

(back to top)