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

Merge branch 'LeoOuyang24-main' into main

pull/30/head
LeoOuyang24 2022-05-06 12:51:32 -07:00 committed by GitHub
parent 7c81b767d4 103acea440
commit 6a21b87ec6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -5,13 +5,19 @@ The free-programming-books-search is a companion project of [free-programming-bo
## Contents
- [Contents](#contents)
- [How It All Works](#how-it-all-works)
- [Installation](#installation)
- [NPM Installation](#npm-installation)
- [Running the Website](#running-the-website)
- [Deployment](#deployment)
- [How It All Works](#how-it-all-works)
- [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
@ -45,13 +51,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-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.
## FAQ
- What database are we using to store the books?