Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/errytagedesign/microver-code-review


https://github.com/errytagedesign/microver-code-review

Last synced: 19 days ago
JSON representation

Awesome Lists containing this project

README

        


logo

Hellow 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)
- [📝 License](#license)

# 📖 Hello Microverse Project

A Microverse Perosnal Portfolio Project developed with duo of HTML and CSS. In addition, i added Linters for Html and Css.

## 🛠 Built With

1-HTML
2-CSS

### Tech Stack

Client

### Key Features

- Add index.html file.
- Add style.css file.
- Add Linters.
- Add Header to the index.html file.
- Add Hero section to the index.html file.
- Add global styling variables to style.html file.

(back to top)

## 🚀 Live Demo

Live Demo Link

(back to top)

## 💻 Getting Started

### Prerequisites

1-Web Browser
2-Code Editor
3-Git

### Setup

Clone this repository to your desired folder:

Run this Command:

```sh
cd my-folder
git clone [email protected]:Errytagedesign/microverse-portfolio.git
```

### Install

First you need to install the node package files
Run this command:

```sh
cd microverse-portfolio
npm install
```

### Usage

- In order to use this project you either create branch to add more features.
- But in order to run the project open index.html with live server

### Run Linters

I have added the linters or tests in order to avoid anykind of typos and ensure the good practices in this project. So while using this repository if you need to check your work in html and css you can use below commands

- in order to run the linter test on index.html:

```sh
npx hint .
```

- in order to run the linter test on stylesheets:

```sh
npx styleint "**/*.{css,scss}"
```

### Deployment

- You can easily use github pages, netlify or vercel to deploy your project
Useful link about Github Pages
Step by Step guide to deploy using netlify
Step by Step guide to deploy using vercel

(back to top)

## 👥 Authors

👤 Sodeeq Awoyemi

- GitHub: [@githubhandle](https://github.com/Errytagedesign)
- Twitter: [@twitterhandle](https://twitter.com/errytage)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/errytagedesigns/)

(back to top)

## 🔭 Future Features

- [ ] Add Recent Work
- [ ] Add About Me
- [ ] Add Tech Stacks
- [ ] Add Qoutes
- [ ] Add Contact Form
- [ ] Add Footer
- [ ] Add more Styling

(back to top)

## 🤝 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 just give it a star -

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse.

(back to top)

## 📝 License

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

(back to top)