Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor codebase #4

Merged
merged 3 commits into from
Mar 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
#gitigonre
node_modules
test.md
node_modules/
test.md
3 changes: 0 additions & 3 deletions .vscode/settings.json

This file was deleted.

91 changes: 54 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
<a name="readme-top"></a>
<!-- TABLE OF CONTENTS -->

# 📗 Table of Contents
# 📗 Table of Contents <a name="readme-top"></a>

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
Expand All @@ -10,42 +7,53 @@
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

<!-- PROJECT DESCRIPTION -->

# 📖 [Hello World] <a name="about-project"></a>
# 📖 About the Project <a name="about-project"></a>

This project is for learning purposes only.

The reason for this is to learn about fundamental concepts of development like:

- Branching
- Linters
- GitHub Actions
- GitHub flow
- Pull-request
- How to write a documentation
- gitignore
- GitHub pages deployment

## 🛠 Built With <a name="built-with"></a>

### Tech Stack <a name="tech-stack"></a>

- HTML
- CSS
- HTML5
- CSS3

<!-- Features -->

### Key Features <a name="key-features"></a>

- **[Using linters]**
- **Using Linters**
- **GitHub Actions**

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- LIVE DEMO -->

## 🚀 Live Demo <a name="live-demo"></a>

- [Live Demo](https://github.com/M-AminAlizadeh/Hello-world)
- [Live Demo](https://m-aminalizadeh.github.io/Hello-world/)

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand All @@ -57,27 +65,43 @@ To get a local copy up and running, follow these steps.

### Setup

Clone this repository to your local machine
Clone this repository to your local machine using this command:

```bash
git clone https://github.com/M-AminAlizadeh/Hello-world.git
cd Hello-world
```

### Install

<!-- Install this project with: -->
Install this project with:

### Usage
```bash
npm install
```

Be sure you installed the node.js on your system so to find out follow these steps:

<!-- To run the project, execute the following command: -->
1. open your system terminal and enter the below command:

```bash
node --version
npm --version
```

1. if you couldn't find that means you don't have them on your system then visit
[Node](https://nodejs.org/en/download) website and download it on your system.

### Run tests
### Usage

<!-- To run tests, run the following command: -->
To run the project, just open the `index.html` file on your browser.

### Deployment
### Deployment <a name="deployment"></a>

<!-- You can deploy this project using: -->
You can deploy this project using various platforms like:

- [Vercel](https://vercel.com/)
- [Netlify](https://www.netlify.com/)

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand All @@ -87,20 +111,11 @@ Clone this repository to your local machine

👤 **Amin Alizadeh**

- GitHub: [Github](https://github.com/M-AminAlizadeh)
- Twitter: [Twitter](https://twitter.com/AMINALI69393891)
- LinkedIn: [Linkedin](https://www.linkedin.com/in/m-amin-alizadeh-60a20b1b0/)
- GitHub: [GitHub](https://github.com/M-AminAlizadeh)
- Linkedin: [Linkedin](https://www.linkedin.com/in/m-amin-alizadeh/)

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- FUTURE FEATURES -->

<!-- ## 🔭 Future Features <a name="future-features"></a>

- [ ] **[new_feature_1]** -->

<!-- <p align="right">(<a href="#readme-top">back to top</a>)</p> -->

<!-- CONTRIBUTING -->

## 🤝 Contributing <a name="contributing"></a>
Expand All @@ -113,22 +128,24 @@ Feel free to check the [issues page](https://github.com/M-AminAlizadeh/Hello-wor

<!-- SUPPORT -->

## ⭐️ Show your support <a name="support"></a>
If you like this project don't forget to star it.
## <a href="#support">⭐️ Show your support </a>

If you like this project don't forget to give it a ⭐️star.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- ACKNOWLEDGEMENTS -->

## 🙏 Acknowledgments <a name="acknowledgements"></a>
I would like to thank Microverse

I would like to thank Microverse for providing this simple and beneficial idea.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- LICENSE -->

## 📝 License <a name="license"></a>

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

<p align="right">(<a href="#readme-top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
Loading