Skip to content

Commit c97736d

Browse files
authored
Update README.md
1 parent 6d7bb3e commit c97736d

File tree

1 file changed

+0
-38
lines changed

1 file changed

+0
-38
lines changed

README.md

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1 @@
11
# Node.js Chat App
2-
3-
A simple demo chat app built on [Node.js](https://nodejs.org/), [Express.js](https://expressjs.com/) and [Socket.io](https://socket.io/).
4-
5-
## Demo
6-
7-
https://owan-nodejs-chat-app.herokuapp.com
8-
9-
## Pre-requisites
10-
11-
To setup and run the project for local development / testing, you will need to use Node.js and NPM. I don't explicitly specify a minimum Node.js/NPM version for the app but I recommend going with whatever the latest LTS version is at the point in time you are setting things up. The minimum vesion of Node.js that I have tested this app on is **10.16.3**.
12-
13-
Installers can be found here: [https://nodejs.org/en/download](https://nodejs.org/en/download/)
14-
15-
Another option for installing Node is the **Node Version Manager** (**nvm**), which is a POSIX-compliant bash script to manage multiple active Node.js versions. Instructions for installing and using nvm to install Node and NPM can be found at [https://github.com/nvm-sh/nvm](https://github.com/nvm-sh/nvm).
16-
17-
## Installation
18-
19-
The code for the chat app can be found at the public [GitHub](https://github.com/) repo [https://github.com/owanhunte/nodejs-chat-app](https://github.com/owanhunte/nodejs-chat-app). Either clone the repo to a local folder on your machine or download and extract the archive if you don't have [Git](https://git-scm.com/) installed.
20-
21-
Open a terminal window session, or the equivalent on your machine, and enter the following command to install all the Node modules needed to run the app:
22-
23-
```sh
24-
npm install
25-
```
26-
27-
## Run the app in development mode
28-
29-
After doing an `npm install` enter the following `npm run` command:
30-
31-
```sh
32-
npm run dev
33-
```
34-
35-
This will start the app and set it up to listen for incoming connections on port 3000. Open up your browser of choice and go to the url [http://localhost:3000/](http://localhost:3000/) to start using the app itself. The `npm run dev` command automatically runs the app using the `nodemon` script so any changes you make to the app's javascript, CSS or HTML code will automatically restart it.
36-
37-
## Customizing the listening port
38-
39-
To configure the port that the app listens on at startup, copy the file `.env.example`, located at the root of the project, to `.env` and set an appropriate value for the `PORT` environment variable listed in the file. This must be done before the app is started.

0 commit comments

Comments
 (0)