Musoye/helpbot

MERN STACK + PYTHON

This template provides a minimal setup to get HelpBot working locally.

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• A browser (e.g. Chrome, Firefox)
• An IDE (e.g. VIM)
• npm
• Terminal

Setup

To clone this repository to your desired folder, follow the steps below:

Using the command line

• Use the following commands

  cd my-folder
  git clone https://github.com/cyriacusceifo/helpbot.git

Using GitHub Desktop app

• Follow the steps below

  • Visit this link click me
  • Click the green button labelled "code"
  • Select the "Open with GitHub Desktop" option
  • After the GitHub Desktop add opens, click the "clone repo" button

Usage

To run the project, execute the following command:

run npm install --force on your terminal to install the necessary dependencies run npm run frontend on your terminal to run the project frontend locally **vi package.json **Edit the type attribute and replace the value "module" with "commonjs" run npm run dev on your terminal to run the project backend locally. cd client and run npm run dev on your terminal to run the project chatwidget locally. run mongod on your terminal to setup mongodb for the project's database locally. On another terminal, run 'python3 app.py' to start the chatservices.

Deployment

To be updated later.

(back to top)

👥 Authors

Musoye

• GitHub: @Musoye
• Twitter: @Musoye
• LinkedIn: Musoye

Cyriacusifeco

• GitHub: @Cyriacusifeco
• Twitter: @DrCyri
• LinkedIn: LinkedIn

👤 Charlian

• GitHub: @CharlyAnne
• Twitter: @Imoisiliii
• LinkedIn: LinkedIn

Ogungbile

• GitHub: @Ogungbile
• Twitter: [@tobi_ogungbile(https://twitter.com/tobi_ogungbile)
• LinkedIn: LinkedIn

🔭 Future Features

• Centralized Chat review from the dashboard
• Chat Widget customization
• One-click Installation

(back to top)

🤝 Contributing

The Helpbot Team

(back to top)