An open API service indexing awesome lists of open source software.

https://github.com/vicky002/customer-bot

Online customer Care Bot.
https://github.com/vicky002/customer-bot

artificial-intelligence bots customer deep-learning machine-learning

Last synced: 6 months ago
JSON representation

Online customer Care Bot.

Awesome Lists containing this project

README

          

# Customer-Bot

A bot for online customer support.

![Banner](/customerbot/images/banner.png)

## Index

- [What does it do](#what-does-it-do)
- [App structuring](#app-structuring)
- [Installation](#installation)
- [Clone it](#clone-it)
- [Setting up site locally](#setting-up-site-locally)
- [Deploying on the server](#deploying-on-the-server)
- [Bot not working](#webapp-not-working)
- [Contributing](#contributing)
- [TODO](#todo)
- [License](#license)

## What does it to
[:arrow_up: Back to top](#index)

## App structuring
[:arrow_up: Back to top](#index)

```sh
.
├── LICENSE
├── README.md
├── bin
├── customer-bot [This file will contain automated installation script]
├── .gitignore [files and folders to avoid while pushing code]
├── setup.py [This file is used to upload project as Python package]
├── requirements.txt [This is for all the project module requirements]

```

## Installation
[:arrow_up: Back to top](#index)

### Clone it
```
$ cd ~
$ git clone https://github.com/vicky002/customer-bot.git [Enter your username and password]

```
Now to start working on the project, please create a branch

```
$ cd customer-bot
$ git checkout -b my_branch_name

```
Now you are in your branch! Make changes, build features or just poke around.
When you start something new, make sure that you pull all the changes from master branch to your branch.

```
$ git pull origin master [Then make all the changes]
$ git add your_files and folders
$ git commit -m 'your_commit_message'
$ git push origin my_branch_name

```
Install `pylint` for all python code linting and maintaing coding standards

```
$ sudo apt-get install pylint
```

Now, whenever you make any change in the code please run `pylint file_or_module_name` and fix all the others before pushing your code.

That's all! Once you're done with your new feature, create a pull request. Each PR will be reviewed by one of us before it goes to `master` branch. This way we all will be on the same track of what's happening in your codebase.

### Setting up site locally

[Will be updated very soon]

### Deploying on the server

[Will be updated very soon]

## Bot not working
[:arrow_up: Back to top](#index)

If you performed all the steps properly and bot is still not working locally, please write an email to [Vikesh Tiwari](mailto:tvicky002@gmail.com).

## Contributing
[:arrow_up: Back to top](#index)

[This will be updated after launching the project]

### Todo
[:arrow_up: Back to top](#index)

## License
[:arrow_up: Back to top](#index)

Built with :heart: and Python by [Vikesh Tiwari](http://tasdikrahman.me/), [Siddharth Shekhar](your_link_here) and [Shaquib Khan]().

You can find a copy of the License at [LICENSE](/LICENSE)