https://github.com/nitbravoa92/hello-microverse
Simple html and css project to practice how to work with linters and github flow
https://github.com/nitbravoa92/hello-microverse
Last synced: 3 days ago
JSON representation
Simple html and css project to practice how to work with linters and github flow
- Host: GitHub
- URL: https://github.com/nitbravoa92/hello-microverse
- Owner: NitBravoA92
- License: mit
- Created: 2023-04-26T13:16:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-27T00:05:19.000Z (over 2 years ago)
- Last Synced: 2025-01-21T14:46:45.408Z (9 months ago)
- Language: HTML
- Size: 103 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Hello Microverse
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
**Hello Microverse** is a simple Html/Css project to practice how to install and work with html and css linters.
Client
- **Linters installation**
- **Diagnosis of HTML and CSS code to detect and fix technical issues**
To get a local copy up and running, follow these steps.
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder-name
git clone git@github.com:NitBravoA92/hello-microverse.git
```
### Prerequisites
In order to install, modify and run this project, it is necessary to have the following applications installed:
- **Git:** to manage the project versions of source code. [You can Download Git here](https://git-scm.com/)
- **Nodejs and NPM:** to install and manage the project dependencies. [Nodejs and NPM installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- **A code editor** like Visual Studio Code (Recommended) or any other of your preference. It is necessary to open the project and add or modify the source code. [You can Download Visual Studio Code here](https://code.visualstudio.com/)
It is also important to have at least basic knowledge of HTML and CSS languages, so you will be able to understand and work with the html and css code of the project.
- [Learn the basics of HTML](https://developer.mozilla.org/en-US/docs/Web/HTML)
- [Learn the basics of CSS](https://developer.mozilla.org/en-US/docs/Web/CSS)
### Install
Install this project by running the next command into your project folder:
```sh
npm install
```
### Usage
Open the HTML or CSS files and modify the internal code and then run the following command:
```sh
npx run .
npx stylelint "**/*.{css,scss}"
```
This will show you a log with details about errors (if any) and changes that would be necessary to solve those errors and improve the code.
**Note**: Please only modify the HTML and CSS files. Do not modify the configuration files of the project.
👤 **Nitcelis Bravo**
- GitHub: [Nitcelis Bravo](https://github.com/NitBravoA92)
- Twitter: [@softwareDevOne](https://twitter.com/softwareDevOne)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/nitcelis-bravo-alcala-b65340158)
- [ ] **Add new html content like a navbar section with a logo, a main content section, and a footer section.**
- [ ] **Add custom CSS styles to style the new sections of the web page, focused on responsiveness.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
To do Contributions, please fork this repository, create a new branch and then create a Pull Request from your branch. You can find detailed description of this process in: [A Step by Step Guide to Making Your First GitHub Contribution by Brandon Morelli](https://codeburst.io/a-step-by-step-guide-to-making-your-first-github-contribution-5302260a2940)
If you liked this project, give me a "Star" (clicking the star button at the beginning of this page), and share this repo with your developer community.
I would like to thank my Microverse teammates for their support. They have helped me a lot by giving me tips and reviews to improve the project.
This project is [MIT](./LICENSE) licensed.