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
213 Commits
2 Branches
0 Tags
7.1 MiB
JavaScript 74.4%
CSS 20.1%
HTML 5.5%
 
 
 
Go to file
github-actions[bot] b834952a47 update fpb.json 2022-07-28 00:01:25 +00:00
.github chore: created PR template 2022-07-05 12:53:30 +02:00
public Update page title 2022-02-17 18:34:43 -05:00
src fix: reset wrapped section style for 960 media query 2022-07-07 21:17:36 +02:00
.gitignore chore: readded '/build' to gitignore 2022-07-10 17:49:11 +02:00
LICENSE Initial commit 2022-01-27 13:01:18 -05:00
README.md hotfix over #23, #24 applying #22 again 2022-07-10 21:04:38 +02:00
fpb.json update fpb.json 2022-07-28 00:01:25 +00:00
package-lock.json Fix compilation error in theme manager 2022-07-04 15:37:06 -04:00
package.json updated REadme. Also dark mode is now changed based on browser pref 2022-04-25 18:04:25 -04:00

README.md

free-programming-books-search

The free-programming-books-search is a companion project of 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 may not be immediately reflected.

Contents

How It All Works

  1. THERE IS NO DATABASE INVOLVED. Rather, the books are stored in a markdown on free-programming-books and is parsed daily by 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

  1. Make sure you have Node.js installed. If you already do, skip to Running the Website.
  2. Otherwise, download the LTS installer from Node.js website.
  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.
  7. Make sure to check out the NPM website for more info.

Running the Website

  1. Make sure you have Git 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.
  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.

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.
    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.
  3. Run npm run deploy.
  4. This should deploy your code to "https://yourusername.github.io/free-programming-books-search/".

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 take up to 24 hours for the search to reflect that.