Skip to content

vicky002/customer-bot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Customer-Bot

A bot for online customer support.

Banner

Index

What does it to

⬆️ Back to top

App structuring

⬆️ Back to top

.
├── 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

⬆️ Back to top

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

⬆️ Back to top

If you performed all the steps properly and bot is still not working locally, please write an email to Vikesh Tiwari.

Contributing

⬆️ Back to top

[This will be updated after launching the project]

Todo

⬆️ Back to top

License

⬆️ Back to top

Built with ❤️ and Python by Vikesh Tiwari, Siddharth Shekhar and Shaquib Khan.

You can find a copy of the License at LICENSE