Skip to content
This repository has been archived by the owner on Feb 8, 2024. It is now read-only.

Latest commit

 

History

History
52 lines (36 loc) · 2.88 KB

SETUP.md

File metadata and controls

52 lines (36 loc) · 2.88 KB

How to set up to contribute to the project

It is recommended that you install and use Git Bash for commands in the following instructions.
In order to succesfully run the project on your local system, you will need to set up MongoDB on your system too. Instructions are given below.

Downloading the Project

  1. Fork the GitHub repository.
    image

  2. Copy and clone your fork's URL using the git clone [URL] command.
    Copy -
    image
    Clone -
    image

  3. Change your directory to reach chatApp folder using cd chatApp

  4. Install the required Node.js modules by running npm install (make sure you have Node.js installed on your system)
    image

Downloading and Installing MongoDB on Windows

  1. Download MongoDB Community server from their site.
    image

  2. Select 'Complete' in their 'choose setup type' section of the installer.
    image

  3. On the next section, select Install MongoDB as a service -> Run service as Network Service user
    image

  4. Install MongoDB compass (GUI Interface for MongoDB)

  5. Install

  6. Create a file named .env in the project directory and write the following line in it -

    MONGO_URL="mongodb://127.0.0.1:27017"

    image

  7. Make sure the MongoDB Database Server background process is running (in Task Manager). In case it isn't open services.msc from Windows search/Run and right-click and start the process MongoDB Server.
    image

  8. Finally, run node index.js in your terminal/Git bash. Visit localhost:8080to see the chatApp working.


You are required to sign up with an Email ID/Password (can be anything, a valid Email ID is not required so far). Login with the credentials and you'll land at the ChatApp's main page.

Open the folder in your choice of editor to edit to make changes to the project.