Internet Test Bot API

This is an API for an internet test chatbot(NETDAN) on dialogflow. This project uses the following technologies:

1. Flask
2. Swagger
3. SQLAlchemy

Project Setup

Follow these steps to have a local running copy of the app.

1. Fastest way to have a runnig local version of this project is:

Pull and run an already built docker image of the same project. First, you need to [setup docker on your local environment] (https://docs.docker.com/engine/install/)

• If your all set, in that case, run docker pull hmutegeki/chatbot:latest to pull the image
• Then check is your image was pulled successfully by running docker list to see all images
• If you see the image, now you can run it docker run -p 5000:5000 hmutegeki/chatbot:latest
• Then navigate to your browser on localhost:5000 api should display a success message
• Navigate to api-docs to see the available endpoints localhost:5000/apidocs

2. The second method to setup the project is below:

Clone The Repo

git clone <url-to-repo>

If master is not up to date, git checkout develop. However, note that code on develop could be having some minor issues to sort.

Install PostgreSQL

Here's a great resource to check out:

How To Install and Use PostgreSQL

Create a development database and call it dev_db.

Create a Virtual Environment

create virtual enviroment called venv

Run virtualenv venv

Activate the virtual environment.

Run . venv/bin/activate

Make sure you have pip installed on your machine.

Install the dependencies.

pip install -r requirements.txt

Create a .env file

Create a .env file (which defines the environment variables used) at the root of the app.

Add the following details, customizing as needed.

export FLASK_APP=server.py
export FLASK_ENV=development
export FLASK_RUN_PORT=5000
export DATABASE_URI="Place the postgresqlURI for production db"

Run Database migrations

Run migrations for the database

python manage.py db upgrade

Run Application

Run the application with this command

flask run

Test the API

Through your browser go to link localhost:<flask_port>/.

Checkout Api docs

Through your browser go to link localhost:<flask_port>/apidocs.