Awesome Books ES6

├── index.js ├── index.css ├── murple_logo.png ├── .hintrc ├── index.html ├── .eslintrc.json ├── package.json ├── .stylelintrc.json ├── MIT.md ├── .github └── workflows │ └── linters.yml └── README.md /index.js: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /index.css: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /murple_logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Adholah96/Awesome-books-E6/HEAD/murple_logo.png -------------------------------------------------------------------------------- /.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 | } -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Awesome Books ES6 9 | 10 | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "env": { 3 | "browser": true, 4 | "es6": true, 5 | "jest": true 6 | }, 7 | "parser": "babel-eslint", 8 | "parserOptions": { 9 | "ecmaVersion": 2018, 10 | "sourceType": "module" 11 | }, 12 | "extends": ["airbnb-base"], 13 | "rules": { 14 | "no-shadow": "off", 15 | "no-param-reassign": "off", 16 | "eol-last": "off", 17 | "import/extensions": [ 1, { 18 | "js": "always", "json": "always" 19 | }] 20 | }, 21 | "ignorePatterns": [ 22 | "dist/", 23 | "build/" 24 | ] 25 | } 26 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "awesome-books-e6", 3 | "version": "1.0.0", 4 | "description": "", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/Adholah96/Awesome-books-E6.git" 12 | }, 13 | "keywords": [], 14 | "author": "", 15 | "license": "ISC", 16 | "bugs": { 17 | "url": "https://github.com/Adholah96/Awesome-books-E6/issues" 18 | }, 19 | "homepage": "https://github.com/Adholah96/Awesome-books-E6#readme" 20 | } 21 | -------------------------------------------------------------------------------- /.stylelintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": ["stylelint-config-standard"], 3 | "plugins": ["stylelint-scss", "stylelint-csstree-validator"], 4 | "rules": { 5 | "at-rule-no-unknown": [ 6 | true, 7 | { 8 | "ignoreAtRules": ["tailwind", "apply", "variants", "responsive", "screen"] 9 | } 10 | ], 11 | "scss/at-rule-no-unknown": [ 12 | true, 13 | { 14 | "ignoreAtRules": ["tailwind", "apply", "variants", "responsive", "screen"] 15 | } 16 | ], 17 | "csstree/validator": true 18 | }, 19 | "ignoreFiles": ["build/**", "dist/**", "**/reset*.css", "**/bootstrap*.css", "**/*.js", "**/*.jsx"] 20 | } 21 | -------------------------------------------------------------------------------- /MIT.md: -------------------------------------------------------------------------------- 1 | ## Copyright 2023, heldricks adhola and Yidnekachew Kassahun 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy of this awesome books and associated documentation files, to deal in the awesome books without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the awesome books, and to permit persons to whom the awesome books 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 awesome books. 6 | 7 | THE awesome books 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 awesome books OR THE USE OR OTHER DEALINGS IN THE awesome books. 8 | -------------------------------------------------------------------------------- /.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-js/.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-js/.stylelintrc.json 47 | - name: Stylelint Report 48 | run: npx stylelint "**/*.{css,scss}" 49 | eslint: 50 | name: ESLint 51 | runs-on: ubuntu-22.04 52 | steps: 53 | - uses: actions/checkout@v2 54 | - uses: actions/setup-node@v1 55 | with: 56 | node-version: "12.x" 57 | - name: Setup ESLint 58 | run: | 59 | npm i -D esquery@1.4.0 --save-exact 60 | npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x 61 | [ -f .eslintrc.json ] || wget https://raw.githubusercontent.com/microverseinc/linters-config/master/html-css-js/.eslintrc.json 62 | - name: ESLint Report 63 | run: npx eslint . 64 | nodechecker: 65 | name: node_modules checker 66 | runs-on: ubuntu-22.04 67 | steps: 68 | - uses: actions/checkout@v2 69 | - name: Check node_modules existence 70 | run: | 71 | 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 72 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | 27 | 28 |

29 | 30 | 31 |
32 | 33 | 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 | # 📖 AWESOME BOOKS 64 | 65 | 66 | 67 | **Awesome books** is a project built with HTML and Javascript. 68 | 69 | ## 🛠 Built With 70 | 71 | - **HTML** 72 | - **CSS** 73 | - **JAVASCRIPT** 74 | 75 | 76 | 77 | ### Key Features 78 | 79 | 80 | 81 | - **Object Constructors** 82 | - **Local Storage** 83 | - **Object Oriented Programming** 84 | 85 |

(back to top)

86 | 87 | 88 | 89 | ## 🚀 Live Demo 90 | 91 | 92 | 93 | - [Coming soon](#) 94 | 95 |

(back to top)

96 | 97 | ## 💻 Getting Started 98 | 99 | ### Prerequisites 100 | 101 | In order to run this project you need: 102 | 103 | - Visual Studio Code 104 | - A Browser 105 | - Node 106 | - Git 107 | 108 | ### Setup 109 | 110 | Clone this repository to your desired folder: 111 | 112 | Example commands: 113 | 114 | ```sh 115 | cd 116 | git clone git@github.com:Adholah96/awesom-books.git 117 | cd awesom-books 118 | ``` 119 | 120 | ### Install 121 | 122 | Install this project with: 123 | 124 | ```sh 125 | npm install 126 | ``` 127 | 128 | ### Usage 129 | 130 | To run the project, execute the following command: 131 | 132 | - Open the the index.html file in the browser or 133 | - Install Live Server extension when using Visual code and open with Live server extension 134 | 135 |

(back to top)

136 | 137 | 138 | 139 | ## 👥 Authors 140 | 141 | 142 | 143 | 👤 **HELDRICKS ADHOLA** 144 | 145 | - GitHub: [@adholah96](https://github.com/Adholah96) 146 | - Twitter: [@nerdy*me*](https://twitter.com/nerdy_me_) 147 | - LinkedIn: [heldricks-arthur](https://linkedin.com/in/heldricks-arthur-59ab2411a) 148 | 149 | 👤 **Yidnekachew Kassahun** 150 | 151 | - GitHub: [Yidne](https://github.com/Yidnekachew-cmd) 152 | - Twitter: [Yidne](https://twitter.com/Yidnekassahun) 153 | - LinkedIn: [Yidne](https://www.linkedin.com/in/yidnekachew-kassahun-2b817a24b/) 154 | 155 |

(back to top)

156 | 157 | 158 | 159 | ## 🔭 Future Features 160 | 161 | 162 | 163 | - **More Functionality** 164 | 165 |

(back to top)

166 | 167 | 168 | 169 | ## 🤝 Contributing 170 | 171 | Contributions, issues, and feature requests are welcome! 172 | 173 | 174 | 175 |

(back to top)

176 | 177 | 178 | 179 | ## ⭐️ Show your support 180 | 181 | Always leave a ⭐️ if you like this project and any of my other projects. 182 | 183 |

(back to top)

184 | 185 | 186 | 187 | ## 🙏 Acknowledgments 188 | 189 | 190 | 191 | Passing my sincere gratitude to Cynthia from Behance for the design template. 192 | 193 |

(back to top)

194 | 195 | 196 | 197 | 200 | 201 | 210 | 211 | 212 | 213 | ## 📝 License 214 | 215 | This project is [MIT](./MIT.md) licensed. 216 | 217 |

(back to top)

218 | --------------------------------------------------------------------------------