https://github.com/rubydevi/hello-microverse
https://github.com/rubydevi/hello-microverse
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rubydevi/hello-microverse
- Owner: rubydevi
- Created: 2023-04-25T13:44:42.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-26T10:23:37.000Z (about 2 years ago)
- Last Synced: 2024-12-29T15:12:40.473Z (5 months ago)
- Language: HTML
- Size: 170 KB
- Stars: 3
- 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)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
**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.
Client
- HTML and CSS
- **Configured Linters**
- **Added an HTML File**
- **Added a CSS file**
### 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:
```sh
cd my-folder
git clone [email protected]:rubydevi/Hello-Microverse.git
cd Hello-Microverse
```
### Install
Install this project with:
**Weblint**
1. Run this code:
```sh
npm install --save-dev [email protected]
```
2. Don't forget to copy [.hintrc](.hintrc) to the root directory of your project.
3. Run this code after you write your html code.
```sh
npm hint .
```
4. It will show you errors, fix all the errors shown.
**Stylelint**
1. Run this code:
```sh
npm install --save-dev [email protected] [email protected] [email protected] [email protected]
```
2. Don't forget to copy [.stylelintrc.json](./.stylelintrc.json) to the root directory of your project.
3. Run this code after you write your html code.
```sh
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:
```sh
npm hint .
```
👤 **Chongtham Ruby Devi**
- GitHub: [@githubhandle](https://github.com/rubydevi)
- Twitter: [@twitterhandle](https://twitter.com/ariesabyss)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/chongtham-bhoomika/)
- 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
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project please leave a star, I'd really appreciate it.
- I'd like to thank Microverse for this wonderful README template.
This project is [MIT](./MIT.md) licensed.