Skip to content

Commit 1f6d6b6

Browse files
committed
Updated README for detailed instructions
1 parent 8719c65 commit 1f6d6b6

File tree

2 files changed

+49
-9
lines changed

2 files changed

+49
-9
lines changed

README.md

Lines changed: 47 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,53 @@
11
# Viral Load Sample Management System #
22

3-
A simple, open source Sample Management System specifically for Viral Load tests.
3+
A simple, open source Sample Management System for Viral Load, EID and Covid-19 testing.
44

5-
### How to get started ? ###
5+
#### Pre-requisites
6+
* Apache2
7+
* MySQL 5+
8+
* PHP 7+
69

7-
* Download the latest code and unzip it in your htdocs or www folder into a new folder for eg. vlsm
8-
* Enter the mysql connection settings in includes/MysqlDb.php
9-
* Now you can access the system at http://localhost/vlsm
1010

11-
### Who do I talk to? ###
11+
#### How do I get started?
12+
* Download the Source Code and put it into your server's root folder (www or htdocs).
13+
* Open phpMyAdmin or any MySQL client and create a blank database
14+
* Import the initial sql file from the releases page
15+
* Rename configs/config.production.dist.php to configs/config.production.php
16+
* 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.
1217

13-
* You can reach us at hello (at) deforay (dot) com
18+
```php
19+
// Enable/Disable Modules
20+
// true => Enabled
21+
// false => Disabled
22+
$systemConfig['modules']['vl'] = true;
23+
$systemConfig['modules']['eid'] = true;
24+
$systemConfig['modules']['covid19'] = true;
25+
```
26+
27+
* 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
28+
* Before we set up the virtual host, ensure that the apache rewrite module is enabled in your Apache webserver settings
29+
* Edit your computer's hosts file to make an entry for this virtual host name
30+
* Next we create a virtual host pointing to the root folder of the source code. You can see an example below :
31+
32+
```apache
33+
<VirtualHost *:80>
34+
DocumentRoot "C:\wamp\www\vlsm"
35+
ServerName vlsm
36+
AddDefaultCharset UTF-8
37+
38+
<Directory "C:\wamp\www\vlsm">
39+
Options Indexes MultiViews FollowSymLinks
40+
AllowOverride All
41+
Order allow,deny
42+
Allow from all
43+
</Directory>
44+
</VirtualHost>
45+
```
46+
47+
#### Next Steps
48+
* Please add the Province, Districts manually in the database. In the near future, we will add UI to add these
49+
* Once you have the application set up, you can visit the vlsm URL http://vlsm/ and log in with the credentials admin and 123
50+
* Now you can start adding Users, facilities and set up the global config.
51+
52+
#### Who do I talk to?
53+
You can reach us at hello (at) deforay (dot) com

header.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@
1919

2020
$logoName = "<img src='/assets/img/flask.png' style='margin-top:-5px;max-width:22px;'> <span style=''>VLSM</span>";
2121
$smallLogoName = "<img src='/assets/img/flask.png'>";
22-
$systemType = "Viral Load Sample Management";
22+
$systemType = "Lab Sample Management Module";
2323
$shortName = "VLSM";
2424
if (isset($sarr['user_type']) && $sarr['user_type'] == 'remoteuser') {
2525
$skin = "skin-red";
26-
$systemType = "VL Sample Tracking System";
26+
$systemType = "Remote Sample Tracking Module";
2727
$logoName = "<i class='fa fa-medkit'></i> VLSTS";
2828
$smallLogoName = "<i class='fa fa-medkit'></i>";
2929
$shortName = "VLSTS";

0 commit comments

Comments
 (0)