From 1f6d6b602b694672faad67a60198d8124a0075a0 Mon Sep 17 00:00:00 2001 From: Amit Dugar Date: Fri, 24 Apr 2020 15:11:46 +0530 Subject: [PATCH] Updated README for detailed instructions --- README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++------- header.php | 4 ++-- 2 files changed, 49 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ff1dd13a2c..dc158603d4 100755 --- a/README.md +++ b/README.md @@ -1,13 +1,53 @@ # Viral Load Sample Management System # -A simple, open source Sample Management System specifically for Viral Load tests. +A simple, open source Sample Management System for Viral Load, EID and Covid-19 testing. -### How to get started ? ### +#### Pre-requisites +* Apache2 +* MySQL 5+ +* PHP 7+ -* Download the latest code and unzip it in your htdocs or www folder into a new folder for eg. vlsm -* Enter the mysql connection settings in includes/MysqlDb.php -* Now you can access the system at http://localhost/vlsm -### Who do I talk to? ### +#### How do I get started? +* Download the Source Code and put it into your server's root folder (www or htdocs). +* Open phpMyAdmin or any MySQL client and create a blank database +* Import the initial sql file from the releases page +* Rename configs/config.production.dist.php to configs/config.production.php +* You can enable or disable VL,EID or Covid-19 module by changing the following variables in config.production.php. If a module is disabled, then it does not appear on the User Interface. -* You can reach us at hello (at) deforay (dot) com \ No newline at end of file +```php +// Enable/Disable Modules +// true => Enabled +// false => Disabled +$systemConfig['modules']['vl'] = true; +$systemConfig['modules']['eid'] = true; +$systemConfig['modules']['covid19'] = true; +``` + +* Next we will set up virtual host for this application. You can find many guides online on this topic. For example to set up on Ubuntu you can follow this guide : https://www.digitalocean.com/community/tutorials/how-to-set-up-apache-virtual-hosts-on-ubuntu-18-04 +* Before we set up the virtual host, ensure that the apache rewrite module is enabled in your Apache webserver settings +* Edit your computer's hosts file to make an entry for this virtual host name +* Next we create a virtual host pointing to the root folder of the source code. You can see an example below : + +```apache + + DocumentRoot "C:\wamp\www\vlsm" + ServerName vlsm + AddDefaultCharset UTF-8 + + + Options Indexes MultiViews FollowSymLinks + AllowOverride All + Order allow,deny + Allow from all + + +``` + +#### Next Steps +* Please add the Province, Districts manually in the database. In the near future, we will add UI to add these +* Once you have the application set up, you can visit the vlsm URL http://vlsm/ and log in with the credentials admin and 123 +* Now you can start adding Users, facilities and set up the global config. + +#### Who do I talk to? +You can reach us at hello (at) deforay (dot) com \ No newline at end of file diff --git a/header.php b/header.php index 08e7730d30..59e378e8a8 100755 --- a/header.php +++ b/header.php @@ -19,11 +19,11 @@ $logoName = " VLSM"; $smallLogoName = ""; -$systemType = "Viral Load Sample Management"; +$systemType = "Lab Sample Management Module"; $shortName = "VLSM"; if (isset($sarr['user_type']) && $sarr['user_type'] == 'remoteuser') { $skin = "skin-red"; - $systemType = "VL Sample Tracking System"; + $systemType = "Remote Sample Tracking Module"; $logoName = " VLSTS"; $smallLogoName = ""; $shortName = "VLSTS";