├── .gitignore
├── style.css
├── index.html
├── .hintrc
├── package.json
├── .stylelintrc.json
├── MIT.md
├── .github
└── workflows
│ └── linters.yaml
└── README.md
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules/
2 | test.md
--------------------------------------------------------------------------------
/style.css:
--------------------------------------------------------------------------------
1 | .title {
2 | color: chartreuse;
3 | }
4 |
--------------------------------------------------------------------------------
/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 | Hello Microverse
9 |
10 |
11 | Hello Microverse!
12 |
13 |
--------------------------------------------------------------------------------
/.hintrc:
--------------------------------------------------------------------------------
1 | {
2 | "connector": {
3 | "name": "local",
4 | "options": {
5 | "pattern": ["**", "!.git/**", "!node_modules/**"]
6 | }
7 | },
8 | "extends": ["development"],
9 | "formatters": ["stylish"],
10 | "hints": [
11 | "button-type",
12 | "disown-opener",
13 | "html-checker",
14 | "meta-charset-utf-8",
15 | "meta-viewport",
16 | "no-inline-styles:error"
17 | ]
18 | }
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "hello-microverse",
3 | "version": "1.0.0",
4 | "description": "This my first project at Microverse as Micronaut 🚀🤓",
5 | "main": "index.js",
6 | "scripts": {
7 | "test": "echo \"Error: no test specified\" && exit 1"
8 | },
9 | "keywords": [],
10 | "author": "",
11 | "license": "ISC",
12 | "devDependencies": {
13 | "hint": "^7.1.8",
14 | "stylelint": "^13.13.1",
15 | "stylelint-config-standard": "^21.0.0",
16 | "stylelint-csstree-validator": "^1.9.0",
17 | "stylelint-scss": "^3.21.0"
18 | }
19 | }
20 |
--------------------------------------------------------------------------------
/.stylelintrc.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": ["stylelint-config-standard"],
3 | "plugins": ["stylelint-scss", "stylelint-csstree-validator"],
4 | "rules": {
5 | "at-rule-no-unknown": null,
6 | "scss/at-rule-no-unknown": [
7 | true,
8 | {
9 | "ignoreAtRules": [
10 | "tailwind",
11 | "apply",
12 | "variants",
13 | "responsive",
14 | "screen"
15 | ]
16 | }
17 | ]
18 | },
19 | "csstree/validator": true,
20 | "ignoreFiles": ["build/**", "dist/**", "**/reset*.css", "**/bootstrap*.css"]
21 | }
22 |
--------------------------------------------------------------------------------
/MIT.md:
--------------------------------------------------------------------------------
1 | ## Copyright 2023, Ahmed Eid
2 |
3 | Permission is hereby granted, free of charge, to any person obtaining a copy of this webpage and associated documentation files, to deal in the webpage without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the webpage, and to permit persons to whom the webpage is furnished to do so, subject to the following conditions:
4 |
5 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the webpage.
6 |
7 | THE webpage IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE webpage OR THE USE OR OTHER DEALINGS IN THE webpage.
--------------------------------------------------------------------------------
/.github/workflows/linters.yaml:
--------------------------------------------------------------------------------
1 | name: Linters
2 |
3 | on: pull_request
4 |
5 | env:
6 | FORCE_COLOR: 1
7 |
8 | jobs:
9 | lighthouse:
10 | name: Lighthouse
11 | runs-on: ubuntu-22.04
12 | steps:
13 | - uses: actions/checkout@v3
14 | - uses: actions/setup-node@v3
15 | with:
16 | node-version: "18.x"
17 | - name: Setup Lighthouse
18 | run: npm install -g @lhci/cli@0.11.x
19 | - name: Lighthouse Report
20 | run: lhci autorun --upload.target=temporary-public-storage --collect.staticDistDir=.
21 | webhint:
22 | name: Webhint
23 | runs-on: ubuntu-22.04
24 | steps:
25 | - uses: actions/checkout@v3
26 | - uses: actions/setup-node@v3
27 | with:
28 | node-version: "18.x"
29 | - name: Setup Webhint
30 | run: |
31 | npm install --save-dev hint@7.x
32 | [ -f .hintrc ] || wget https://raw.githubusercontent.com/microverseinc/linters-config/master/html-css/.hintrc
33 | - name: Webhint Report
34 | run: npx hint .
35 | stylelint:
36 | name: Stylelint
37 | runs-on: ubuntu-22.04
38 | steps:
39 | - uses: actions/checkout@v3
40 | - uses: actions/setup-node@v3
41 | with:
42 | node-version: "18.x"
43 | - name: Setup Stylelint
44 | run: |
45 | npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x
46 | [ -f .stylelintrc.json ] || wget https://raw.githubusercontent.com/microverseinc/linters-config/master/html-css/.stylelintrc.json
47 | - name: Stylelint Report
48 | run: npx stylelint "**/*.{css,scss}"
49 | nodechecker:
50 | name: node_modules checker
51 | runs-on: ubuntu-22.04
52 | steps:
53 | - uses: actions/checkout@v3
54 | - name: Check node_modules existence
55 | run: |
56 | if [ -d "node_modules/" ]; then echo -e "\e[1;31mThe node_modules/ folder was pushed to the repo. Please remove it from the GitHub repository and try again."; echo -e "\e[1;32mYou can set up a .gitignore file with this folder included on it to prevent this from happening in the future." && exit 1; fi
57 |
58 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
Hello Microverse
6 |
7 |
8 |
9 |
10 | # 📗 Table of Contents
11 |
12 | - [📖 About the Project](#about-project)
13 | - [🛠 Built With](#built-with)
14 | - [Tech Stack](#tech-stack)
15 | - [Key Features](#key-features)
16 | - [💻 Getting Started](#getting-started)
17 | - [Setup](#setup)
18 | - [Prerequisites](#prerequisites)
19 | - [Install](#install)
20 | - [Usage](#usage)
21 | - [👥 Authors](#authors)
22 | - [🔭 Future Features](#future-features)
23 | - [🤝 Contributing](#contributing)
24 | - [⭐️ Show your support](#support)
25 | - [🙏 Acknowledgements](#acknowledgements)
26 | - [📝 License](#license)
27 |
28 |
29 |
30 | # 📖 Hello Microverse
31 |
32 | > My project is about setting up the basic config for lintr and other tools that will be used in the program
33 |
34 |
35 | **Hello Microverse** is a...
36 |
37 | ## 🛠 Built With
38 |
39 | ### Tech Stack
40 |
41 | > built with html and css.
42 |
43 |
44 | Client
45 |
48 |
51 |
52 |
53 |
54 |
55 |
56 |
57 | ### Key Features
58 |
59 | - **adding h1 title**
60 | - **adding color using css to the title**
61 |
62 |
63 |
64 | (back to top )
65 |
66 |
67 |
68 | ## 💻 Getting Started
69 |
70 | > this project for testing purpose of lintr
71 |
72 | To get a local copy up and running, follow these steps.
73 |
74 | ### Prerequisites
75 |
76 | In order to run this project you need: have 'npm' package manger
77 |
78 | ### Setup
79 |
80 | Clone this repository to your desired folder:
81 |
82 |
83 | ```sh
84 | cd my-folder
85 | git clone https://github.com/ahmedeid6842/Hello-Microverse.git
86 | ```
87 |
88 |
89 | ### Install
90 |
91 | Install this project with: npm
92 |
93 | ```sh
94 | npm install
95 | ```
96 |
97 | ### Usage
98 |
99 | To run the project, execute the following command: open index.html as normal file or using Live Server
100 |
101 | (back to top )
102 |
103 |
104 |
105 | ## 👥 Authors
106 |
107 | 👤 **Author1**
108 |
109 | - GitHub: [@ahmedeid6842](https://github.com/ahmedeid6842)
110 | - Twitter: [@ahmedeid2684](https://twitter.com/ahmedeid2684)
111 | - LinkedIn: [@ahmedeid](https://www.linkedin.com/in/ahmed-eid-0018571b1/)
112 |
113 | (back to top )
114 |
115 |
116 |
117 | ## 🔭 Future Features
118 |
119 | - [ ] **[make the website more interative]**
120 |
121 | (back to top )
122 |
123 |
124 |
125 | ## 🤝 Contributing
126 |
127 | Contributions, issues, and feature requests are welcome!
128 |
129 | Feel free to check the [issues page](../../issues/).
130 |
131 | (back to top )
132 |
133 |
134 |
135 | ## ⭐️ Show your support
136 | If you like this project, please give it a star ⭐️
137 |
138 | (back to top )
139 |
140 |
141 |
142 | ## 🙏 Acknowledgments
143 |
144 | > Microverse inspired me.
145 |
146 | I would like to thank Microverse
147 |
148 | (back to top )
149 |
150 | ## 📝 License
151 |
152 | This project is [MIT](./MIT.md) licensed.
153 |
154 | (back to top )
--------------------------------------------------------------------------------