Install From GitHub

You can download or clone the Lemur Engine code repository from our GitHub

https://github.com/theramenrobotdiscocode/lemur-engine

The Lemur Engine is written in Laravel and can be developed and deployed like any Laravel application.

For more information visit: https://laravel.com/docs/7.x

To get you going as quickly as possible we have included a vagrant file so you can set Lemur Engine up on your own machine and get testing and developing in no time.

Prerequisite

You will need the following installed on your machine to run the Lemur Engine locally.

• Virtual Box
• Vagrant

Follow the steps below to set this up on your machine.

Step One

Copy .env.sample to .env and fill in the details.

The .env.sample file has already has the default vagrant DB settings.

You may need to change these to match your settings.

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=lemurengine
DB_USERNAME=root
DB_PASSWORD=secret


Step Two

Create an entry in your /etc/hosts file

Step Three

Start the server, login and go to the root directory

Step Four

Create the database - the login details below are the default vagrant mysql settings. In this example the database is called 'lemurengine'.

Step Five

On the VM inside the /vagrant directory run composer to install the dependencies.

Step Six

On the VM inside the /vagrant directory and run the following commands to set up Laravel

If you encounter a symlink() error when running the last command then exit the vm and try to run the same command from the project root in the host machine.

The default local url is http://lemurengine.local

You should be able to log in as an admin the following:

Change this password either directly using tinker. Or using the forgotten email feature at the front of the site.

Setup

Copy .env to .env-testing

An example .env.testing file has been included with the default vagrant DB settings.

You should change these to match your settings.

DB_CONNECTION=testing
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=testing
DB_USERNAME=root
DB_PASSWORD=secret


Create the testing database - the login details below are the default vagrant mysql settings.

This will create a database which is used during testing so that you dont destroy the data in your actual database.

Run All Tests

Run the to every test in the collection.

From the root directory run:

php artisan test --testsuite=All

AIML Conversations Tests

Run the following to test the AIML conversation flow.

These are high level tests which test that for a given conversation input you get the correct bot output.

From the /vagrant directory run:

php artisan test --testsuite=Aiml

Tag Class Tests

Run the following to test the Tag classes.

From the /vagrant directory run:

php artisan test --testsuite=Tags

Unit Tests

Run the following to run any unit tests.

From the /vagrant directory run:

php artisan test --testsuite=Unit

Request Class Tests

Run the following to unit test the request classes.

From the /vagrant directory run:

php artisan test --testsuite=Requests

Feature Tests

Run the following to run any feature tests.

From the /vagrant directory run:

php artisan test --testsuite=Feature

Repository Tests

Run the following to run any repository tests.

From the /vagrant directory run:

php artisan test --testsuite=Repositories

Controller Tests

Run the following to run any controller tests.

From the /vagrant directory run:

php artisan test --testsuite=Controllers

API Tests

Run the following to run any api tests.

From the /vagrant directory run:

php artisan test --testsuite=APIs

Policy Tests

Run the following to run any policy tests.

From the /vagrant directory run:

php artisan test --testsuite=Policies