EbookFoundation
/
free-programming-books-search
mirror of https://github.com/EbookFoundation/free-programming-books-search.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

remove trailing spaces to fix markdownlint rule: MD009/no-trailing-spaces [Expected: 0 or 2; Actual: 1]

pull/22/head
David Ordás 2022-04-30 19:12:55 +02:00
parent aa6899fe08
commit ca50ecd8b1
No known key found for this signature in database
GPG Key ID: 6FD751229911593E
1 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -3,9 +3,7 @@ free-programming-books-search
</a> </a>
</h1> </h1>
The 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.
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](#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. 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. 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 ### 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. 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) 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` 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! 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. 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. 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 <repo url>`,replacing <repo url> with the url of your github repository. 3. Type `git remote add origin <repo url>`,replacing <repo url> with the url of your github repository.
2. Now, run `npm install -g gh-pages`. 2. Now, run `npm install -g gh-pages`.
3. Run `npm run deploy`. 3. Run `npm run deploy`.
@ -46,16 +44,15 @@ MAKE SURE YOU HAVE COMPLETED THE INSTALLATION STEPS FIRST!
## How It All Works ## How It All Works
1. THERE IS NO DATABASE INVOLVED. Rather, the books are stored in a markdown on [ 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 ## FAQ
- What database are we using to store the books? - 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? - 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 tak up to 24 hours for the search to reflect that.