https://github.com/eccb7/hello-world
https://github.com/eccb7/hello-world
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/eccb7/hello-world
- Owner: Eccb7
- License: mit
- Created: 2023-04-25T10:00:10.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-26T11:07:00.000Z (about 2 years ago)
- Last Synced: 2025-02-02T02:48:01.595Z (3 months ago)
- Language: HTML
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Hello Microverse README
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [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)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
**This is a project is a project involving setting up a Hello World repository with the aim the needed mastery of various tools and best practices just learnt in the previous steps. Being that there is no required complex coding for this exercise, it serves as a foundation essential for all microverse projects and future jobs. The completion of this project will result to my first code review, a critical part in Microverse project process. this project helps me gain valuable experience and also develop essential skills neccesary for the success in my future career.**
## 🛠 Built With
### Tech Stack
- **HTML5**
- **CSS3**
### Key Features
- **It's able to detect html bugs**
- **It's able to detect css bugs**
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- HTML, CSS, and Javascript know-how.
- Git installation
- A text editor
- A terminal
- A web browser to view output e.g Google Chrome
- An IDE e.g Visual studio code
### Setup
Clone this repository to your desired folder:
Commands:
```sh
cd hello microverse
git clone [email protected]:Eccb7/Hello.git
```
### Install
Install this project with:
Command:
```sh
cd Hello
gem install
```
### Usage
To run the project, execute the following command:
- After Cloning this repo to your local machine
- Open the index.html in your browser
### Run tests
To run tests, run the following command:
To track linter errors locally follow these steps:
Download all the dependencies run:
```sh
npm install
```
Track HTML linter errors run:
```sh
npx hint .
```
Track CSS linter errors run:
```sh
npx stylelint "**/*.{css,scss}"
```
👤 **Ojwang Briton**
- GitHub: [@Eccb7](https://github.com/Eccb7)
- Twitter: [@briton_otieno4](https://twitter.com/briton_otieno4)
- LinkedIn: [briton-otieno-ba6591244](https://linkedin.com/in/briton-otieno-ba6591244)
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project you can reach me through [@briton_otieno4](https://twitter.com/briton_otieno4) and share more thoughts to help improve
I would like to thank Microverse for the support I've received so far.
This project is [MIT](./LICENSE) licensed.