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

How it All Works is now at the top of ReadMe

pull/23/head
leo ouyang 2022-05-06 15:45:44 -04:00
parent a6194a504e
commit 103acea440
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -16,6 +16,12 @@ free-programming-books](https://ebookfoundation.github.io/free-programming-books
- [Deployment](#deployment)
- [FAQ](#faq)
## 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.
2. This Json is downloaded locally and searched locally when the actual search function is used.
## Installation
### NPM Installation
@ -44,12 +50,6 @@ MAKE SURE YOU HAVE COMPLETED THE INSTALLATION STEPS FIRST!
3. Run `npm run deploy`.
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.
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?