microfin

A micro-finance solution written using the Laravel web framework.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

• Composer
• Bower
• >= PHP 7.1

Installing

Please run the following commands to setup your development env up.

# clone this repository
git clone https://github.com/faddai/microfin.git

# change directory
cd microfin/

# install the project's dependencies using Composer
composer install

# install frontend dependencies using Bower
bower install

# make a copy of the .env.example to configure the application 
# for your local environment
cp .env.example .env

Update your .env file with appropriate values for your database, cache, mail, etc,

# run the migrations together with the seeders to setup the database
php artisan migrate --seed

Run the setup command to create a Super admin user for the application

php artisan microfin:setup

Running the application

If your development environment is set up using Homestead or Valet, please follow the guides that come with your chosen tool.

Otherwise, you can use the development server the ships with Laravel by running, from the project root:

php artisan serve

You can visit http://localhot:8000 to see the application in action.

Running the tests

There are tests for some Controllers, Jobs, Entities and Listeners available in the tests/ directory.

# to run all tests
phpunit tests/

Deployment

TDB

Built With

• Laravel - The web framework used
• Bootstrap - The CSS framework used

Contributing

TDB

Authors

• Francis Addai - Initial work - faddai

License

This project is licensed under the MIT License - see the LICENSE file for details