Update ReadMe as per revised ReadMe in master branch authored by Wes Li (wel191)'s avatar Wes Li (wel191)
...@@ -188,36 +188,61 @@ nodejs, sqlite3, express, ejs, nodemailer ...@@ -188,36 +188,61 @@ nodejs, sqlite3, express, ejs, nodemailer
``` ```
### Installing ### Installing
Initially, download and install nodejs
How to run the application: ```
https://nodejs.org/en/download/
```
### How to Run
Clone the git branch Command line tool(s) must be used: Windows PowerShell or Mac Terminal
Note: Must run the command line tool(s) as an administrator or Sudo in Mac OS
**Cloning the Project**:
Clone the git **master** branch using the command line tool(s)
``` ```
git clone https://git.cs.usask.ca/yol474/cmpt370-fantastic-4.git git clone https://git.cs.usask.ca/yol474/cmpt370-fantastic-4.git
``` ```
Download and install nodejs Or use the GitHub Desktop to clone a repository to a designated path by entering the below URL
``` ```
https://nodejs.org/en/download/ https://git.cs.usask.ca/yol474/cmpt370-fantastic-4.git
``` ```
Navigate to the **air370proj** folder that contains **app.js** Navigate to the **cmpt370-fantastic-4** folder that contains **app.js** in the the command line tool(s)
``` ```
cmpt370-fantastic-4\air370proj\AirPararies370proj\air370proj cmpt370-fantastic-4/
``` ```
Use npm to install the following requirements. **Setting Up Required Node Modules**:
**First**, use npm to create an empty package
``` ```
npm init npm init
```
Keep pressing "Enter" until you see "Is this OK? (yes)"
Enter "yes" to continue
**Second**, use npm to install the following requirements
```
npm i sqlite3 npm i sqlite3
npm i express npm i express
npm i ejs npm i ejs
npm i nodemailer npm i nodemailer
``` ```
Note: if the warning "Permission Denied" is shown, has to re-run command line tool(s)
as an administrator or Sudo in Mac Os as indicated previously and repeat the above steps
**To Start the Application**:
Run app.js using command line Run app.js using command line
...@@ -227,6 +252,8 @@ node app.js ...@@ -227,6 +252,8 @@ node app.js
Application will be live on port 2020 Application will be live on port 2020
Enter below URL into your browser, **Google Chrome** recommended
``` ```
localhost:2020/ localhost:2020/
``` ```
... ...
......