From 099ee1d54093bfc5c6a01b93f9d69d332b88b22a Mon Sep 17 00:00:00 2001 From: leo ouyang Date: Thu, 21 Apr 2022 20:52:58 -0400 Subject: [PATCH] readme update --- README.md | 24 +++++++++++++++++++++++- package.json | 2 +- 2 files changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 720936d..56ec62c 100644 --- a/README.md +++ b/README.md @@ -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 `,replacing with the url of your github repository. + 2. Now, run `npm run deploy`. + 3. This should deploy your code to "https:.github.io/free-programming-books-search/" + \ No newline at end of file diff --git a/package.json b/package.json index 8a3eabd..1a7342e 100644 --- a/package.json +++ b/package.json @@ -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,