Skip to content

Latest commit

 

History

History
98 lines (62 loc) · 2.17 KB

README.md

File metadata and controls

98 lines (62 loc) · 2.17 KB

i5 logo

i5

A comprehensive redesign of the i4 database for the Small Claims Advisory Service. The live version of this project can be accessed at i5.masmallclaims.org

Installation

Setting up the Database

System Requirements

Make sure MySQL database is InnoDB format. This will allow for foreign key constraints to be applied. In addition, i5 relies on the ability to operate a mail server. Also remove the Client factory command statement.

Defining the Environment

In order to populate the database with information, you will need to first define the database details. Located in .env are the following definitions that you can adjust if necessary. DB_DATABASE should be kept as is.

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=8889
DB_DATABASE=i5
DB_USERNAME=root
DB_PASSWORD=root

Next, you will also need to define the mail account through which user emails will be sent:

MAIL_MAILER=smtp
MAIL_HOST=mailhog
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS="[email protected]"
MAIL_FROM_NAME="${APP_NAME}"

Migrations

To create all the necessary database structures, run this command:

php artisan migrate

If you need to reverse any changes:

php artisan migrate:rollback --step=1

Running a Seeder

php artisan db:seed

Running The App

Upload the files to your document root, or if you are running your own server, use the following command

php artisan serve

Updating definitions

Located in lang/en/messages.php is a list of defined terms that may change from year to year (e.g. webmaster's name, email, etc.)—all you need to do is to edit their definitions in this file and they will update across the app.

Usage

For Volunteers

Requesting an Invite

Searching Clients

Creating a Client

Managing Contacts

For Administrators

Managing User Invites

Managing User Roles

About the Project