Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gh-reza/hellomicroverse

Last synced: 9 days ago
JSON representation

Host: GitHub
URL: https://github.com/gh-reza/hellomicroverse
Owner: Gh-Reza
Created: 2023-04-25T18:21:27.000Z (almost 2 years ago)
Default Branch: master
Last Pushed: 2023-04-25T22:13:48.000Z (almost 2 years ago)
Last Synced: 2024-12-30T13:37:45.168Z (28 days ago)
Language: HTML
Size: 644 KB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        



  


  
Hello Microverse Project




# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 [Hello microverse] 

**[Hello microverse]** is a project to make students learn about linters and other project initial settings.

## 🛠 Built With 

### Tech Stack 

  Client

  


    HTML5

    CSS3

  


  Server

  


    VS CODE Live Server Extension

  


### Key Features 

- **[Best Practices]**

In this project best coding practices is use

## 💻 Getting Started 

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

Google Chrome or other browser

```sh

  https://www.google.com/chrome/?brand=JJTC&gclid=CjwKCAjw9J2iBhBPEiwAErwpeSDcMFWiIQWj2u5GY6owZ7OaOHw7dYYCHW7uTR4kvYosNJYd4wt4VxoCiywQAvD_BwE&gclsrc=aw.ds

```

Github Account:

```sh

  https://github.com/

```

Npm installed: 

```sh

  https://nodejs.org/en/download

```

Git installed: 

```sh

  https://git-scm.com/book/en/v2/Getting-Started-Installing-Git

```

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone [email protected]:Gh-Reza/HelloMicroverse.git

```

### Install

Install this project with:

Linters:

Lighthouse run:

```sh

  npm install -g @lhci/[email protected]

```

Webhint run 

```sh

 npm install --save-dev [email protected]

```

StyleLint run:

```sh

 npm install --save-dev [email protected] [email protected] [email protected] [email protected]

```

### Usage

To run the project, execute the following command:

```sh

  cd HelloMicroverse

  index.html

```

### Run tests

To run tests, run the following command:

to check for styling errors:

```sh

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

```

To test optimization:

```sh

  lighthouse [site url]

```

### Deployment

You can deploy this project using:

Your working browser.

## 👥 Authors 

👤 **Ghulam Reza Merzaie**

- GitHub: [@githubhandle](https://github.com/Gh-Reza)

- Twitter: [@twitterhandle](https://twitter.com/RezaMerzaie)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/reza-merzaie-b94368202/)

## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

If you like this project, don't forget to star.

(back to top)


## 📝 License 

This project is [MIT](./MIT.md) licensed.

(back to top)