Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

How it All Works is now at the top of ReadMe #23

Merged
merged 2 commits into from
May 6, 2022
Merged

How it All Works is now at the top of ReadMe #23

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a6194a5
How it All Works is now at the top of ReadMe
May 6, 2022
103acea
How it All Works is now at the top of ReadMe
May 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,19 @@ free-programming-books](https://ebookfoundation.github.io/free-programming-books

## 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
Expand Down Expand Up @@ -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?
Expand Down