Kevin

Web Application to Inspect HTTP Requests & Build Custom Endpoints.

Installation

In order to run this app do the following:

Default Install

1. Get the application code

git clone https://github.com/Clivern/Kevin.git kevin
cd kevin
cp .env.example .env

2. Install dependencies

pip install -r requirements.txt

3. Edit the .env file manually or use command for that

# Set DB Host
python manage.py kevin update_env DB_HOST=127.0.0.1

# Set DB Port
python manage.py kevin update_env DB_PORT=3306

# Set DB Name
python manage.py kevin update_env DB_DATABASE=kevin

# Set DB Username
python manage.py kevin update_env DB_USERNAME=root

# Set DB Password
python manage.py kevin update_env DB_PASSWORD=

# Create a new app key (Required)
python manage.py kevin update_app_key

# Set DB Type (mysql or sqlite supported till now)
python manage.py kevin update_env DB_CONNECTION=mysql

4. Migrate The Database.

python manage.py migrate

5. Run The Server

python manage.py runserver

6. Run the Jobs Schedule.

python manage.py schedule run < /dev/null
# Or as a process
python manage.py schedule run </dev/null &

7. Go to http://127.0.0.1:8000/install to install the application.

With Docker

1. Get the application code

git clone https://github.com/Clivern/Kevin.git kevin
cd kevin
cp .env.docker .env

2. Then run our docker containers

docker-compose build
docker-compose up -d

3. Open your browser and access the http://127.0.0.1:8000/.

4. Also you can add http://kevin.com to your /etc/hosts file.

127.0.0.1:8000       kevin.com

5. To Check our containers, use the following command:

docker-compose ps

6. To stop our containers

docker-compose down

Running on production

Currently kevin is still under development and for sure we will explain how to run it on production after the first release.

Automated Deployment

Currently we support chef to deploy kevin and even automate your deployment with each release. Just use this chef cookbook and you will amazed with the features it supports.

Misc

Changelog

Version 1.0.0:

Coming Soon.

Acknowledgements

© 2018, Clivern. Released under The Apache Software License, Version 2.0.

Kevin is authored and maintained by @clivern.