From ca50ecd8b1c775081ba0d2bf8b331d862ca8e088 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Ord=C3=A1s?= <3125580+davorpa@users.noreply.github.com> Date: Sat, 30 Apr 2022 19:12:55 +0200 Subject: [PATCH 01/13] remove trailing spaces to fix markdownlint rule: MD009/no-trailing-spaces [Expected: 0 or 2; Actual: 1] --- README.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a2f33e2..107a324 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,7 @@ free-programming-books-search -The -free-programming-books-search is a companion project of [ -free-programming-books](https://ebookfoundation.github.io/free-programming-books/). It allows users to search by book title or author and filter by language. The search index is updated once per day, so changes made on [free-programming-books](https://ebookfoundation.github.io/free-programming-books/) may not be immediately reflected. +The free-programming-books-search is a companion project of [free-programming-books](https://ebookfoundation.github.io/free-programming-books/). It allows users to search by book title or author and filter by language. The search index is updated once per day, so changes made on [free-programming-books](https://ebookfoundation.github.io/free-programming-books/) may not be immediately reflected. ## Contents - [Contents](#contents) @@ -27,7 +25,7 @@ free-programming-books](https://ebookfoundation.github.io/free-programming-books 6. Close out of Node by either closing and reopening the command line or with Ctrl + C. 7. Make sure to check out the [NPM website](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) for more info. ### Running the Website -1. Make sure you have [Git](https://git-scm.com/downloads) installed. +1. Make sure you have [Git](https://git-scm.com/downloads) installed. 2. Clone the repo from Github with Git. 3. Navigate to the folder using command line. (easy way is to type "cd" and then drag and drop the folder into command line) 4. Type `npm install` @@ -38,7 +36,7 @@ free-programming-books](https://ebookfoundation.github.io/free-programming-books MAKE SURE YOU HAVE COMPLETED THE INSTALLATION STEPS FIRST! 1. First, make sure that you the local folder containing the files has a remote configured called "origin". 1. If you aren't sure, navigate to the folder using Git (type "cd", then drag and drop folder in to Git command line.). - 2. Type `git init` + 2. Type `git init` 3. Type `git remote add origin `,replacing with the url of your github repository. 2. Now, run `npm install -g gh-pages`. 3. Run `npm run deploy`. @@ -46,16 +44,15 @@ MAKE SURE YOU HAVE COMPLETED THE INSTALLATION STEPS FIRST! ## How It All Works 1. THERE IS NO DATABASE INVOLVED. Rather, the books are stored in a markdown on [ -free-programming-books](https://ebookfoundation.github.io/free-programming-books/) and is parsed daily by [free-programming-books](https://github.com/EbookFoundation/free-programming-books-parser). The books and all info pertaining to them are stored in a json file called fpb.json. +free-programming-books](https://ebookfoundation.github.io/free-programming-books/) and is parsed daily by [free-programming-books](https://github.com/EbookFoundation/free-programming-books-parser). The books and all info pertaining to them are stored in a json file called fpb.json. -2. This Json is downloaded locally and searched locally when the actual search function is used. +2. This Json is downloaded locally and searched locally when the actual search function is used. ## FAQ - + - What database are we using to store the books? - NONE! The books are stored in a json file which is downloaded locally. - I added a book but it's not showing up on search? - Give it some time. The parser is run once a day, so it may tak up to 24 hours for the search to reflect that. - \ No newline at end of file From 1ceff223ea3e155a800109c9a76cd68e89a92bdb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Ord=C3=A1s?= <3125580+davorpa@users.noreply.github.com> Date: Sat, 30 Apr 2022 19:17:54 +0200 Subject: [PATCH 02/13] fix markdownlint rule about blank lines between each heading - MD022/blanks-around-headings/blanks-around-headers: Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] - MD032/blanks-around-lists: Lists should be surrounded by blank lines --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 107a324..a68cac3 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ free-programming-books-search The free-programming-books-search is a companion project of [free-programming-books](https://ebookfoundation.github.io/free-programming-books/). It allows users to search by book title or author and filter by language. The search index is updated once per day, so changes made on [free-programming-books](https://ebookfoundation.github.io/free-programming-books/) may not be immediately reflected. ## Contents + - [Contents](#contents) - [Installation](#installation) - [NPM Installation](#npm-installation) @@ -17,6 +18,7 @@ The free-programming-books-search is a companion project of [free-programming-bo ## Installation ### NPM Installation + 1. Make sure you have [Node.js](https://nodejs.org/en/) installed. If you already do, skip to [Running the Website](#running-the-website) 2. Otherwise, download the LTS installer from [Node.js](https://nodejs.org/en/) website. 3. Follow the instructions of the installer, make sure npm is listed as a package to be installed. @@ -24,7 +26,9 @@ The free-programming-books-search is a companion project of [free-programming-bo 5. Verify that Node.Js has been installed by going to command line and typing in `node`. It should show the current version. 6. Close out of Node by either closing and reopening the command line or with Ctrl + C. 7. Make sure to check out the [NPM website](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) for more info. + ### Running the Website + 1. Make sure you have [Git](https://git-scm.com/downloads) installed. 2. Clone the repo from Github with Git. 3. Navigate to the folder using command line. (easy way is to type "cd" and then drag and drop the folder into command line) @@ -33,6 +37,7 @@ The free-programming-books-search is a companion project of [free-programming-bo 6. Type `npm start`. At this point, the commnand prompt should start up the server, and a tab in your default browser should open up to localhost. ## Deployment + MAKE SURE YOU HAVE COMPLETED THE INSTALLATION STEPS FIRST! 1. First, make sure that you the local folder containing the files has a remote configured called "origin". 1. If you aren't sure, navigate to the folder using Git (type "cd", then drag and drop folder in to Git command line.). @@ -43,6 +48,7 @@ MAKE SURE YOU HAVE COMPLETED THE INSTALLATION STEPS FIRST! 4. This should deploy your code to "https:yourusername.github.io/free-programming-books-search/" ## How It All Works + 1. THERE IS NO DATABASE INVOLVED. Rather, the books are stored in a markdown on [ free-programming-books](https://ebookfoundation.github.io/free-programming-books/) and is parsed daily by [free-programming-books](https://github.com/EbookFoundation/free-programming-books-parser). The books and all info pertaining to them are stored in a json file called fpb.json. From d87151ce6bcd3852e908312411c61c9cfeb29f1e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Ord=C3=A1s?= <3125580+davorpa@users.noreply.github.com> Date: Sat, 30 Apr 2022 19:20:11 +0200 Subject: [PATCH 03/13] MD032/blanks-around-lists: Lists should be surrounded by blank lines --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index a68cac3..0874c2d 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,7 @@ The free-programming-books-search is a companion project of [free-programming-bo ## Deployment MAKE SURE YOU HAVE COMPLETED THE INSTALLATION STEPS FIRST! + 1. First, make sure that you the local folder containing the files has a remote configured called "origin". 1. If you aren't sure, navigate to the folder using Git (type "cd", then drag and drop folder in to Git command line.). 2. Type `git init` From b0d790567fc23946490d56bef63cd19a2361275c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Ord=C3=A1s?= <3125580+davorpa@users.noreply.github.com> Date: Sat, 30 Apr 2022 19:21:10 +0200 Subject: [PATCH 04/13] MD012/no-multiple-blanks: Multiple consecutive blank lines [Expected: 1; Actual: 2] --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 0874c2d..2508352 100644 --- a/README.md +++ b/README.md @@ -62,4 +62,3 @@ free-programming-books](https://ebookfoundation.github.io/free-programming-books - I added a book but it's not showing up on search? - Give it some time. The parser is run once a day, so it may tak up to 24 hours for the search to reflect that. - From 23938611252cb54b74c855315f8be791b291003c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Ord=C3=A1s?= <3125580+davorpa@users.noreply.github.com> Date: Sat, 30 Apr 2022 19:24:51 +0200 Subject: [PATCH 05/13] grammar puntuation --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2508352..5425d29 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ The free-programming-books-search is a companion project of [free-programming-bo ### NPM Installation -1. Make sure you have [Node.js](https://nodejs.org/en/) installed. If you already do, skip to [Running the Website](#running-the-website) +1. Make sure you have [Node.js](https://nodejs.org/en/) installed. If you already do, skip to [Running the Website](#running-the-website). 2. Otherwise, download the LTS installer from [Node.js](https://nodejs.org/en/) website. 3. Follow the instructions of the installer, make sure npm is listed as a package to be installed. 4. Click Install. @@ -31,9 +31,9 @@ The free-programming-books-search is a companion project of [free-programming-bo 1. Make sure you have [Git](https://git-scm.com/downloads) installed. 2. Clone the repo from Github with Git. -3. Navigate to the folder using command line. (easy way is to type "cd" and then drag and drop the folder into command line) -4. Type `npm install` -5. Type `npm install react-scripts` +3. Navigate to the folder using command line. A easy way is to type "cd" and then drag and drop the folder into command line. +4. Type `npm install`. +5. Type `npm install react-scripts`. 6. Type `npm start`. At this point, the commnand prompt should start up the server, and a tab in your default browser should open up to localhost. ## Deployment @@ -42,11 +42,11 @@ MAKE SURE YOU HAVE COMPLETED THE INSTALLATION STEPS FIRST! 1. First, make sure that you the local folder containing the files has a remote configured called "origin". 1. If you aren't sure, navigate to the folder using Git (type "cd", then drag and drop folder in to Git command line.). - 2. Type `git init` - 3. Type `git remote add origin `,replacing with the url of your github repository. + 2. Type `git init`. + 3. Type `git remote add origin `, replacing with the url of your github repository. 2. Now, run `npm install -g gh-pages`. 3. Run `npm run deploy`. -4. This should deploy your code to "https:yourusername.github.io/free-programming-books-search/" +4. This should deploy your code to "https:yourusername.github.io/free-programming-books-search/". ## How It All Works From 0eba6fee3194718bf94f4018fb141795b02cbab2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Ord=C3=A1s?= <3125580+davorpa@users.noreply.github.com> Date: Sat, 30 Apr 2022 19:26:46 +0200 Subject: [PATCH 06/13] fix spellings --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5425d29..03a7923 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ The free-programming-books-search is a companion project of [free-programming-bo 3. Navigate to the folder using command line. A easy way is to type "cd" and then drag and drop the folder into command line. 4. Type `npm install`. 5. Type `npm install react-scripts`. -6. Type `npm start`. At this point, the commnand prompt should start up the server, and a tab in your default browser should open up to localhost. +6. Type `npm start`. At this point, the command prompt should start up the server, and a tab in your default browser should open up to localhost. ## Deployment From 891fce7250f9165263eba8f3e5c6f7f21c1f1d82 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Ord=C3=A1s?= <3125580+davorpa@users.noreply.github.com> Date: Sat, 30 Apr 2022 19:28:23 +0200 Subject: [PATCH 07/13] recover hidden text due to MD033/no-inline-html: Inline HTML [Element: repo] --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 03a7923..ce7f053 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ MAKE SURE YOU HAVE COMPLETED THE INSTALLATION STEPS FIRST! 1. First, make sure that you the local folder containing the files has a remote configured called "origin". 1. If you aren't sure, navigate to the folder using Git (type "cd", then drag and drop folder in to Git command line.). 2. Type `git init`. - 3. Type `git remote add origin `, replacing with the url of your github repository. + 3. Type `git remote add origin `, replacing `` with the url of your github repository. 2. Now, run `npm install -g gh-pages`. 3. Run `npm run deploy`. 4. This should deploy your code to "https:yourusername.github.io/free-programming-books-search/". From e0c1d99c45b4cf31c33069ba13d2cde499532906 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Ord=C3=A1s?= <3125580+davorpa@users.noreply.github.com> Date: Sat, 30 Apr 2022 19:29:12 +0200 Subject: [PATCH 08/13] MD033/no-inline-html: Inline HTML [Element: h1] --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index ce7f053..a420649 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,4 @@ -

-free-programming-books-search - -

+# free-programming-books-search The free-programming-books-search is a companion project of [free-programming-books](https://ebookfoundation.github.io/free-programming-books/). It allows users to search by book title or author and filter by language. The search index is updated once per day, so changes made on [free-programming-books](https://ebookfoundation.github.io/free-programming-books/) may not be immediately reflected. From 2ffc011e7220011c60b7416ea83633f60d09a284 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Ord=C3=A1s?= <3125580+davorpa@users.noreply.github.com> Date: Sat, 30 Apr 2022 19:32:08 +0200 Subject: [PATCH 09/13] backticks for commands and typed text --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a420649..5ffa681 100644 --- a/README.md +++ b/README.md @@ -21,14 +21,14 @@ The free-programming-books-search is a companion project of [free-programming-bo 3. Follow the instructions of the installer, make sure npm is listed as a package to be installed. 4. Click Install. 5. Verify that Node.Js has been installed by going to command line and typing in `node`. It should show the current version. -6. Close out of Node by either closing and reopening the command line or with Ctrl + C. +6. Close out of Node by either closing and reopening the command line or with Ctrl + C. 7. Make sure to check out the [NPM website](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) for more info. ### Running the Website 1. Make sure you have [Git](https://git-scm.com/downloads) installed. 2. Clone the repo from Github with Git. -3. Navigate to the folder using command line. A easy way is to type "cd" and then drag and drop the folder into command line. +3. Navigate to the folder using command line. A easy way is to type "`cd`" and then drag and drop the folder into command line. 4. Type `npm install`. 5. Type `npm install react-scripts`. 6. Type `npm start`. At this point, the command prompt should start up the server, and a tab in your default browser should open up to localhost. @@ -37,18 +37,18 @@ The free-programming-books-search is a companion project of [free-programming-bo MAKE SURE YOU HAVE COMPLETED THE INSTALLATION STEPS FIRST! -1. First, make sure that you the local folder containing the files has a remote configured called "origin". - 1. If you aren't sure, navigate to the folder using Git (type "cd", then drag and drop folder in to Git command line.). +1. First, make sure that you the local folder containing the files has a remote configured called "`origin`". + 1. If you aren't sure, navigate to the folder using Git (type "`cd`", then drag and drop folder in to Git command line). 2. Type `git init`. 3. Type `git remote add origin `, replacing `` with the url of your github repository. 2. Now, run `npm install -g gh-pages`. 3. Run `npm run deploy`. -4. This should deploy your code to "https:yourusername.github.io/free-programming-books-search/". +4. This should deploy your code to "`https:yourusername.github.io/free-programming-books-search/`". ## How It All Works 1. THERE IS NO DATABASE INVOLVED. Rather, the books are stored in a markdown on [ -free-programming-books](https://ebookfoundation.github.io/free-programming-books/) and is parsed daily by [free-programming-books](https://github.com/EbookFoundation/free-programming-books-parser). The books and all info pertaining to them are stored in a json file called fpb.json. +free-programming-books](https://ebookfoundation.github.io/free-programming-books/) and is parsed daily by [free-programming-books](https://github.com/EbookFoundation/free-programming-books-parser). The books and all info pertaining to them are stored in a json file called `fpb.json`. 2. This Json is downloaded locally and searched locally when the actual search function is used. From 8e8c544e2853895bf91b137b629fb9d83dfc8615 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Ord=C3=A1s?= <3125580+davorpa@users.noreply.github.com> Date: Sat, 30 Apr 2022 19:32:43 +0200 Subject: [PATCH 10/13] Use github.io full and valid url --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5ffa681..ab556d9 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ MAKE SURE YOU HAVE COMPLETED THE INSTALLATION STEPS FIRST! 3. Type `git remote add origin `, replacing `` with the url of your github repository. 2. Now, run `npm install -g gh-pages`. 3. Run `npm run deploy`. -4. This should deploy your code to "`https:yourusername.github.io/free-programming-books-search/`". +4. This should deploy your code to "`https://yourusername.github.io/free-programming-books-search/`". ## How It All Works From b02a48e45b634ac57260c78eeff7b75ed199d048 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Ord=C3=A1s?= <3125580+davorpa@users.noreply.github.com> Date: Sat, 30 Apr 2022 19:34:19 +0200 Subject: [PATCH 11/13] spelling typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ab556d9..a29476e 100644 --- a/README.md +++ b/README.md @@ -58,4 +58,4 @@ free-programming-books](https://ebookfoundation.github.io/free-programming-books - NONE! The books are stored in a json file which is downloaded locally. - I added a book but it's not showing up on search? - - Give it some time. The parser is run once a day, so it may tak up to 24 hours for the search to reflect that. + - Give it some time. The parser is run once a day, so it may take up to 24 hours for the search to reflect that. From 9c8fee1daee579394248fa7c1adb89d3ab6e3972 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Ord=C3=A1s?= <3125580+davorpa@users.noreply.github.com> Date: Sat, 30 Apr 2022 19:36:53 +0200 Subject: [PATCH 12/13] JSON acronym in uppercases --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a29476e..2561ecf 100644 --- a/README.md +++ b/README.md @@ -48,14 +48,14 @@ MAKE SURE YOU HAVE COMPLETED THE INSTALLATION STEPS FIRST! ## How It All Works 1. THERE IS NO DATABASE INVOLVED. Rather, the books are stored in a markdown on [ -free-programming-books](https://ebookfoundation.github.io/free-programming-books/) and is parsed daily by [free-programming-books](https://github.com/EbookFoundation/free-programming-books-parser). The books and all info pertaining to them are stored in a json file called `fpb.json`. +free-programming-books](https://ebookfoundation.github.io/free-programming-books/) and is parsed daily by [free-programming-books](https://github.com/EbookFoundation/free-programming-books-parser). The books and all info pertaining to them are stored in a JSON file called `fpb.json`. -2. This Json is downloaded locally and searched locally when the actual search function is used. +2. This JSON is downloaded locally and searched locally when the actual search function is used. ## FAQ - What database are we using to store the books? - - NONE! The books are stored in a json file which is downloaded locally. + - NONE! The books are stored in a JSON file which is downloaded locally. - I added a book but it's not showing up on search? - Give it some time. The parser is run once a day, so it may take up to 24 hours for the search to reflect that. From 4b87a88c4ece66bbc036eff9d772184d11f165d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Ord=C3=A1s?= <3125580+davorpa@users.noreply.github.com> Date: Sat, 30 Apr 2022 19:37:41 +0200 Subject: [PATCH 13/13] free-programming-books-parser link title --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2561ecf..6d069b5 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ MAKE SURE YOU HAVE COMPLETED THE INSTALLATION STEPS FIRST! ## How It All Works 1. THERE IS NO DATABASE INVOLVED. Rather, the books are stored in a markdown on [ -free-programming-books](https://ebookfoundation.github.io/free-programming-books/) and is parsed daily by [free-programming-books](https://github.com/EbookFoundation/free-programming-books-parser). The books and all info pertaining to them are stored in a JSON file called `fpb.json`. +free-programming-books](https://ebookfoundation.github.io/free-programming-books/) and is parsed daily by [free-programming-books-parser](https://github.com/EbookFoundation/free-programming-books-parser). The books and all info pertaining to them are stored in a JSON file called `fpb.json`. 2. This JSON is downloaded locally and searched locally when the actual search function is used.