├── .github └── workflows │ └── linters.yml ├── .gitignore ├── .hintrc ├── .stylelintrc.json ├── MIT.md ├── README.md ├── app_screenshot.png ├── index.html ├── murple_logo.png ├── package-lock.json ├── package.json └── style.css /.github/workflows/linters.yml: -------------------------------------------------------------------------------- 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@v2 14 | - uses: actions/setup-node@v1 15 | with: 16 | node-version: "12.x" 17 | - name: Setup Lighthouse 18 | run: npm install -g @lhci/cli@0.7.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@v2 26 | - uses: actions/setup-node@v1 27 | with: 28 | node-version: "12.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@v2 40 | - uses: actions/setup-node@v1 41 | with: 42 | node-version: "12.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@v2 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 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | test.md -------------------------------------------------------------------------------- /.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 | } 19 | -------------------------------------------------------------------------------- /.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 | 23 | -------------------------------------------------------------------------------- /MIT.md: -------------------------------------------------------------------------------- 1 | ## Copyright 2021, Heldricks Adhola 2 | 3 | 4 | Permission is hereby granted, free of charge, to any person obtaining a copy of this Hello Microverse and associated documentation files, to deal in the Hello Microverse without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the [APP TYPE], and to permit persons to whom the [APP TYPE] is furnished to do so, subject to the following conditions: 5 | 6 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Hello Microverse. 7 | 8 | THE Hello Microverse 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 Hello Microverse OR THE USE OR OTHER DEALINGS IN THE Hello Microverse. 9 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | 27 | 28 |
29 | 30 | logo 31 |
32 | 33 |

Microverse README Template

34 | 35 |
36 | 37 | 38 | 39 | # 📗 Table of Contents 40 | 41 | - [📖 About the Project](#about-project) 42 | - [🛠 Built With](#built-with) 43 | - [Tech Stack](#tech-stack) 44 | - [Key Features](#key-features) 45 | - [🚀 Live Demo](#live-demo) 46 | - [💻 Getting Started](#getting-started) 47 | - [Setup](#setup) 48 | - [Prerequisites](#prerequisites) 49 | - [Install](#install) 50 | - [Usage](#usage) 51 | - [Run tests](#run-tests) 52 | - [Deployment](#triangular_flag_on_post-deployment) 53 | - [👥 Authors](#authors) 54 | - [🔭 Future Features](#future-features) 55 | - [🤝 Contributing](#contributing) 56 | - [⭐️ Show your support](#support) 57 | - [🙏 Acknowledgements](#acknowledgements) 58 | - [❓ FAQ (OPTIONAL)](#faq) 59 | - [📝 License](#license) 60 | 61 | 62 | 63 | # 📖 Hello-microverse 64 | 65 | > Describe your project in 1 or 2 sentences. 66 | 67 | **hello-microverse** is a setup project that showcases my mastery in tools and best practises. 68 | 69 | ## 🛠 Built With 70 | 71 | ### Tech Stack 72 | 73 | > Describe the tech stack and include only the relevant sections that apply to your project. 74 | 75 |
76 | Client 77 | 80 |
81 | 82 |
83 | Server 84 | 87 |
88 | 89 |
90 | Database 91 | 94 |
95 | 96 | 97 | 98 | ### Key Features 99 | 100 | > Describe between 1-3 key features of the application. 101 | 102 | - **Setup linters** 103 | - **Correct gitHub flow** 104 | 105 |

(back to top)

106 | 107 | 108 | 109 | ## 🚀 Live Demo 110 | 111 | > Add a link to your deployed project. 112 | 113 | - [Live Demo Link coming soon](https://yourdeployedapplicationlink.com) 114 | 115 |

(back to top)

116 | 117 | 118 | 119 | ## 💻 Getting Started 120 | 121 | > Describe how a new developer could make use of your project. 122 | 123 | To get a local copy up and running, follow these steps. 124 | 125 | ### Prerequisites 126 | 127 | In order to run this project you need: 128 | 129 | 136 | 137 | ### Setup 138 | 139 | Clone this repository to your desired folder: 140 | 141 | 149 | 150 | ### Install 151 | 152 | Install this project with: 153 | 154 | 161 | 162 | ### Usage 163 | 164 | To run the project, execute the following command: 165 | 166 | 173 | 174 | ### Run tests 175 | 176 | To run tests, run the following command: 177 | 178 | 185 | 186 | ### Deployment 187 | 188 | You can deploy this project using: 189 | 190 | 197 | 198 |

(back to top)

199 | 200 | 201 | 202 | ## 👥 Authors 203 | 204 | > Mention all of the collaborators of this project. 205 | 206 | 👤 **Heldricks Adhola** 207 | 208 | - GitHub: [@adholah96](https://github.com/Adholah96) 209 | - Twitter: [@nerdy_me_](https://twitter.com/nerdy_me_) 210 | - LinkedIn: [heldricks-arthur](https://linkedin.com/in/heldricks-arthur-59ab2411a) 211 | 212 | 213 |

(back to top)

214 | 215 | 216 | 217 | ## 🔭 Future Features 218 | 219 | > Describe 1 - 3 features you will add to the project. 220 | 221 | - [ ] **Better UI/UX style** 222 | - [ ] **Responsive Design** 223 | 224 |

(back to top)

225 | 226 | 227 | 228 | ## 🤝 Contributing 229 | 230 | Contributions, issues, and feature requests are welcome! 231 | 232 | Feel free to check the [issues page](../../issues/). 233 | 234 |

(back to top)

235 | 236 | 237 | 238 | ## ⭐️ Show your support 239 | 240 | > Write a message to encourage readers to support your project 241 | 242 | If you like this project... 243 | 244 |

(back to top)

245 | 246 | 247 | 248 | ## 🙏 Acknowledgments 249 | 250 | > Give credit to everyone who inspired your codebase. 251 | 252 | I would like to thank... 253 | 254 |

(back to top)

255 | 256 | 257 | 258 | ## ❓ FAQ (OPTIONAL) 259 | 260 | > Add at least 2 questions new developers would ask when they decide to use your project. 261 | 262 | - **[Question_1]** 263 | 264 | - [Answer_1] 265 | 266 | - **[Question_2]** 267 | 268 | - [Answer_2] 269 | 270 |

(back to top)

271 | 272 | 273 | 274 | ## 📝 License 275 | 276 | This project is [MIT](./MIT.md) licensed. 277 | 278 |

(back to top)

279 | -------------------------------------------------------------------------------- /app_screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Adholah96/hello-microverse/1779cdbcfd9ce35c0d1ec16a632aceeb1a75e44b/app_screenshot.png -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Document 9 | 10 | 11 |

Hello Microverse!

12 | 13 | -------------------------------------------------------------------------------- /murple_logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Adholah96/hello-microverse/1779cdbcfd9ce35c0d1ec16a632aceeb1a75e44b/murple_logo.png -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "devDependencies": { 3 | "hint": "^7.1.3", 4 | "stylelint": "^13.13.1", 5 | "stylelint-config-standard": "^21.0.0", 6 | "stylelint-csstree-validator": "^1.9.0", 7 | "stylelint-scss": "^3.21.0" 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /style.css: -------------------------------------------------------------------------------- 1 | h1 { 2 | color: aqua; 3 | } 4 | --------------------------------------------------------------------------------