Git Product home page Git Product logo

hello-microverse's Introduction

๐Ÿ“— Table of Contents

๐Ÿ“– 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 [email protected]:rubydevi/Hello-Microverse.git
  cd Hello-Microverse

Install

Install this project with:

Weblint

  1. Run this code:
 npm install --save-dev [email protected]
  1. Don't forget to copy .hintrc to the root directory of your project.

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

 npm hint .
  1. It will show you errors, fix all the errors shown.

Stylelint

  1. Run this code:
  1. Don't forget to copy .stylelintrc.json to the root directory of your project.

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

 npx stylelint "**/*.{css,scss}"
  1. 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

(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)

hello-microverse's People

Contributors

rubydevi avatar

Stargazers

Ansar Ibrahim avatar rod. avatar Kamran Asif avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.