ashmalzahra/Hello-World

This project is a "Hello world" repository. No complex coding is used for this exercise. The goal here is to master all of the tools and best practices learned so far.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

Hello Microverse

Hello Microverse project is built for training and understanding Linters.

Built With

• HTML, CSS
• Git, Github
• VSCode

(back to top)

Tech Stack

Client

• HTML

• CSS

Server

• N/A

Database

• N/A

Key Features

• This is a stable version
• Running the code will print 'Hello Microverse'.
• the title's color is red

(back to top)

🚀 Live Demo

• N/A

(back to top)

Getting Started

Clone the folder to your local machine, make sure to configure linters by following the instructions in the Linters README file

(back to top)

Setup

Set up the yaml file located in .github/workflows/linters.yml

(back to top)

Install

Install all different dependencies of linters file:

• lighthouse (.github/workflows/linters.yml)
• webhint (.github/workflows/linters.yml)
• stylelint (.github/workflows/linters.yml)

(back to top)

Usage

To run the project, execute the following command: open your live server

Run tests

After pushing the changes on github, merge your pull request and let github action process changes. Check for the tests when you generate a pull request and fix errors, if any. For stylelint errors run:sudo npx stylelint "**/*.{css,scss}" --fix for automatic fix.

(back to top)

Deployment

You can deploy this project using: N/A

(back to top)

Authors

👤 Ashmal Zahra

• GitHub: @ashmalzahra
• Twitter: @AshmalZahraa
• LinkedIn: ashmal-zahra

(back to top)

🔭 Future Features

• Next version will have an option to display 'Hello Universe'

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse team for the information provided.

(back to top)

❓ FAQ

• Can I download and use the project?

  • Yes, the project is open source, you can download and use it as you wish.

(back to top)

📝 License

This project is This project is MIT licensed.

(back to top)