├── styles.css
├── murple_logo.png
├── app_screenshot.png
├── .gitignore
├── index.html
├── .hintrc
├── .stylelintrc.json
├── package.json
├── MIT.md
├── .github
└── workflows
│ └── linters.yml
└── README.md
/styles.css:
--------------------------------------------------------------------------------
1 | .heading {
2 | color: blueviolet;
3 | }
4 |
--------------------------------------------------------------------------------
/murple_logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ZewdieMc/Hello-Microverse/HEAD/murple_logo.png
--------------------------------------------------------------------------------
/app_screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ZewdieMc/Hello-Microverse/HEAD/app_screenshot.png
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Ignore node_modules folder
2 | node_modules
3 |
4 | # Ignore test files
5 | test.md
6 |
--------------------------------------------------------------------------------
/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 | Hello Microverse
8 |
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 | }
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 |
23 |
24 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "hello-microverse",
3 | "version": "1.0.0",
4 | "description": "GitHub flow",
5 | "main": "index.html",
6 | "scripts": {
7 | "test": "npm run test"
8 | },
9 | "repository": {
10 | "type": "git",
11 | "url": "git+https://github.com/ZewdieMc/Hello-Microverse.git"
12 | },
13 | "author": "Zewdie Habtie",
14 | "license": "ISC",
15 | "bugs": {
16 | "url": "https://github.com/ZewdieMc/Hello-Microverse/issues"
17 | },
18 | "homepage": "https://github.com/ZewdieMc/Hello-Microverse#readme",
19 | "dependencies": {
20 | "jest": "^29.3.1"
21 | },
22 | "devDependencies": {
23 | "hint": "^7.1.3",
24 | "stylelint": "^13.13.1",
25 | "stylelint-config-standard": "^21.0.0",
26 | "stylelint-csstree-validator": "^1.9.0",
27 | "stylelint-scss": "^3.21.0"
28 | }
29 | }
30 |
--------------------------------------------------------------------------------
/MIT.md:
--------------------------------------------------------------------------------
1 | ## Copyright 2021, Zewdie Habtie
2 |
3 |
4 | Permission is hereby granted, free of charge, to any person obtaining a copy of this [web app] and associated documentation files, to deal in the [web app] without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the [web app], 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 [web app].
7 |
8 | THE [APP TYPE] 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 [WEB APP] OR THE USE OR OTHER DEALINGS IN THE [WEB APP].
9 |
--------------------------------------------------------------------------------
/.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 |
58 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 |
27 |
28 |
29 |
30 |
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 | - [📝 License](#license)
59 |
60 |
61 |
62 | # 📖 Hello Microverse
63 |
64 |
65 | **[Hello Microverse]** is a project created to show the initial set up of our repositories at Microverse. The set up includes the GitHub flow.
66 |
67 | ## 🛠 Built With
68 |
69 | ### Tech Stack
70 |
71 | > This is a simple project built with HTML and CSS
72 |
73 |
74 | Client
75 |
79 |
80 |
81 |
82 | Server
83 |
86 |
87 |
88 |
89 | Database
90 |
93 |
94 |
95 |
96 |
97 | ### Key Features
98 |
99 | > The following are the key features of the application.
100 |
101 | - **Displays only Hello Microverse in blue violet color.**
102 |
103 | (back to top )
104 |
105 |
106 |
107 | ## 🚀 Live Demo
108 |
109 | > Click the live demo to access the application.
110 |
111 | - [Live Demo Link](https://zewdiemc.github.io/Hello-Microverse/)
112 |
113 | (back to top )
114 |
115 |
116 |
117 | ## 💻 Getting Started
118 |
119 |
120 | To get a local copy up and running, follow these steps.
121 |
122 | ### Prerequisites
123 |
124 | In order to run this project you need:
125 |
126 |
133 |
134 | ### Setup
135 |
136 | Clone this repository to your desired folder:
137 |
138 |
139 |
140 |
141 | ```
142 | git clone git@github.com:ZewdieMc/Hello-Microverse.git
143 | ```
144 |
145 | ### Install
146 |
147 | Install this project with:
148 |
149 | ```
150 | npm init -y && npm install
151 | ```
152 |
153 | ### Usage
154 |
155 | To run the project, execute the following command:
156 |
157 |
164 |
165 | ### Run tests
166 |
167 | To run tests, run the following command:
168 |
169 |
176 |
177 | ### Deployment
178 |
179 | You can deploy this project using:
180 |
181 |
188 |
189 | (back to top )
190 |
191 |
192 |
193 | ## 👥 Authors
194 |
195 | > This project is authored by
196 |
197 | 👤 **Author1**
198 |
199 | - GitHub: [@githubhandle](https://github.com/ZewdieMc)
200 | - Twitter: [@twitterhandle](https://twitter.com/HabtieZewdie)
201 | - LinkedIn: [LinkedIn](https://linkedin.com/in/zewdie-habtie-sisay-947153172)
202 |
203 |
204 | (back to top )
205 |
206 |
207 |
208 | ## 🔭 Future Features
209 |
210 | > Describe 1 - 3 features you will add to the project.
211 |
212 | - [ ] **Use css flexbox**
213 | - [ ] **Use css grid system**
214 | - [ ] **Add media queries**
215 |
216 | (back to top )
217 |
218 |
219 |
220 | ## 🤝 Contributing
221 |
222 | Contributions, issues, and feature requests are welcome!
223 |
224 | Feel free to check the [issues page](../../issues/).
225 |
226 | (back to top )
227 |
228 |
229 |
230 | ## ⭐️ Show your support
231 |
232 | > Write a message to encourage readers to support your project
233 |
234 | If you like this project give it a start on GitHub
235 |
236 | (back to top )
237 |
238 |
239 |
240 | ## 🙏 Acknowledgments
241 |
242 | I would like to thank Microverse!
243 |
244 | (back to top )
245 |
246 |
247 |
248 |
249 | (back to top )
250 |
251 |
252 |
253 | ## 📝 License
254 |
255 | This project is [MIT](./MIT.md) licensed.
256 |
257 | _NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._
258 |
259 | (back to top )
260 |
261 |
--------------------------------------------------------------------------------