The CSE Bot

This is the code repository running at the heart of our cute little bot in our slack team.

Contents

• Structure
• Setup
• Testing

Structure

This repo is divided into two parts

• Server Part

  Consisting of following two directories:

  • slack_bot
  • cse_slack_bot

• Bot Features

  This includes the directory bot_box

Server Part

This part deals with the HTTP request-response cycle between our server and that of slack.

Bot Features

This is the main area of contribution. Here is the core code running to ensure the correct response of the bot.

Setup

1. Create a new virtualenv by typing the command:

    $ virtualenv -p python3 <sample-env-name>
   

2. Activate that virtualenv by executing:

    #make sure you are inside your virtualenv directory that is created in prev step then execute
    myvenv $ source bin/activate
   

3. Install the requirements by using the command in terminal:

    (myenv)$ pip install -r requirements.txt
   

4. Create a .env file in the root of the project and obtain the api-keys listed in sample_dotenv file and copy them in .env

5. Run Django server. to check if everything is runing smooth, using the command:

    (myenv)$ python manage.py runserver
   

Now you are ready to add some awesome features in this bot!

Testing

To test your feature there are few simple steps.

1. Run Django server using:

    (myenv)$ python manage.py runserver
   

2. Open /index/ page in your browser.

3. to be continued......

Feel free to contribute

This just in. What up!