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

backticks for commands and typed text

pull/22/head
David Ordás 2022-04-30 19:32:08 +02:00
parent e0c1d99c45
commit 2ffc011e72
No known key found for this signature in database
GPG Key ID: 6FD751229911593E
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

@ -21,14 +21,14 @@ The free-programming-books-search is a companion project of [free-programming-bo
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.
6. Close out of Node by either closing and reopening the command line or with <kbd>Ctrl + C</kbd>.
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
1. Make sure you have [Git](https://git-scm.com/downloads) 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.
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.
@ -37,18 +37,18 @@ The free-programming-books-search is a companion project of [free-programming-bo
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.).
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/".
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.
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.