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

readme update

pull/20/head
leo ouyang 2022-04-21 20:52:58 -04:00
parent 3da70adef5
commit 099ee1d540
2 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -12,6 +12,28 @@ free-programming-books](https://ebookfoundation.github.io/free-programming-books
- [Deployment](#deployment)
## Installation
Nuts Deez
### NPM Installation
1. Make sure you have [Node.js](https://nodejs.org/en/) installed. If you already do, skip to [Running the Website](#running-the-website.)
2. Otherwise, download the LTS installer from [Node.js](https://nodejs.org/en/) 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](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. (easy way is to type "cd" and then drag and drop the folder into command line)
4. Type `npm install -g`
5. Type `npm install react-scripts`
6. Type `npm start`. At this point, the commnand prompt should start up the server, and a tab in your default browser should open up to localhost.
## Deployment
1. First, make sure that you the local folder containing the files has a remote configured called "origin".
a. If you aren't sure, navigate to the folder using Git (type "cd", then drag and drop folder in to Git command line.).
b. Type `git init`
c. Type `git remote add origin <repo url>`,replacing <repo url> with the url of your github repository.
2. Now, run `npm run deploy`.
3. This should deploy your code to "https:<username>.github.io/free-programming-books-search/"

2
package.json
View File

@ -1,5 +1,5 @@
{
"homepage": "https://ebookfoundation.github.io/free-programming-books-search/",
"homepage": "https://leoouyang24.github.io/free-programming-books-search/",
"name": "fpb_search_page",
"version": "0.1.0",
"private": true,