Skip to content

Latest commit

 

History

History
248 lines (226 loc) · 9.26 KB

README.md

File metadata and controls

248 lines (226 loc) · 9.26 KB
Raw

Simple Grave Locator

Simple implementation of Tomb Locator. This web base system allows user to map out a tomb in a map .

Feature List :

  • Manage Tomb Location
  • Search available tomb
  • Manage Tomb Occupants
  • Search Tomb Occupants

Requirement

Installation Process :

  1. Download the project - https://github.com/kevindaus/tomblocator
  2. Extract the project anywhere you like.
  3. Open command prompt and go to that path where you extracted the file. e.g C:\wamp\www\tomblocator
  4. Now go to protected folder by executing cd protected then download the required library by executing composer self-update && composer update
  5. Now execute command cd .. then execute mkdir assets
  6. Now execute command cd protected/config then execute command notepad main.php. Notepad should open then paste this configuration code
<?php

// uncomment the following to define a path alias
// Yii::setPathOfAlias('local','path/to/local-folder');
// This is the main Web application configuration. Any writable
// CWebApplication properties can be configured here.
return array(
    'basePath' => dirname(__FILE__) . DIRECTORY_SEPARATOR . '..',
    'name' => '[Change This to Your Likings]',
    'theme' => 'hebo',
    // preloading 'log' component
    'preload' => array('log'),
    'aliases' => array(
        'bootstrap' => realpath(__DIR__ . '/../extensions/bootstrap'), // change this if necessary
        'yiiwheels' => realpath(__DIR__ . '/../extensions/yiiwheels'),
    ),
    // autoloading model and component classes
    'import' => array(
        'application.models.*',
        'application.components.*',
        'bootstrap.helpers.TbHtml',
        'bootstrap.helpers.TbArray',
        'bootstrap.behaviors.TbWidget',
        'application.modules.user.models.*',
        'application.modules.user.components.*',
        'application.modules.rights.*',
        'application.modules.rights.components.*',
    ),
    'modules' => array(
        'user'=>array(
            'tableUsers' => 'users',
            'tableProfiles' => 'profiles',
            'tableProfileFields' => 'profiles_fields',
            'hash' => 'md5',
            'sendActivationMail' => true,
            'loginNotActiv' => false,
            'activeAfterRegister' => false,
            'autoLogin' => true,
            'registrationUrl' => array('/user/registration'),
            'recoveryUrl' => array('/user/recovery'),
            'loginUrl' => array('/user/login'),
            'returnUrl' => array('/home'),
            'returnLogoutUrl' => array('/user/login'),
        ),
        'rights'=>array(
           'superuserName'=>'admin',
           'authenticatedName'=>'Authenticated',
           'userIdColumn'=>'id',
           'userNameColumn'=>'username',
           'enableBizRule'=>true, 
           'enableBizRuleData'=>true, 
           'displayDescription'=>true, 
           'flashSuccessKey'=>'RightsSuccess',
           'flashErrorKey'=>'RightsError',
           'baseUrl'=>'/rights',
           'layout'=>'rights.views.layouts.main',
           'appLayout'=>'application.views.layouts.main',
           'cssFile'=>'rights.css',
           'install'=>false,
           'debug'=>false, 
        ),
        'gii' => array(
            'class' => 'system.gii.GiiModule',
            'password' => 'password',
            // If removed, Gii defaults to localhost only. Edit carefully to taste.
            'ipFilters' => array('127.0.0.1', '::1'),
        ),
    ),
    // application components
    'components' => array(
        'user'=>array(
                'class'=>'RWebUser',
                'rightsReturnUrl'=>array('authItem/roles'),
                // enable cookie-based authentication
                'allowAutoLogin'=>true,
                'loginUrl'=>array('/user/login'),
        ),
        'authManager'=>array(
                'class'=>'RDbAuthManager',
                'connectionID'=>'db',
                'defaultRoles'=>array('Authenticated', 'Guest'),
        ),
        'bootstrap' => array(
            'class' => 'bootstrap.components.TbApi',
        ),
        'yiiwheels' => array(
            'class' => 'ext.yiiwheels.YiiWheels',
        ),

        // uncomment the following to enable URLs in path-format
        'urlManager' => array(
            'urlFormat' => 'path',
            'rules' => array(
                '/home'=>'site/index',
                '/gallery'=>'site/gallery',
                '/contact'=>'site/contact',
                '/login'=>'user/login',
                '<controller:\w+>/<id:\d+>' => '<controller>/view',
                '<controller:\w+>/<action:\w+>/<id:\d+>' => '<controller>/<action>',
                '<controller:\w+>/<action:\w+>' => '<controller>/<action>',
            ),
        ),
        'db'=>array(
            'connectionString' => 'mysql:host=localhost;dbname=CHANGE_THIS_TO_DATABASENAME',
            'emulatePrepare' => true,
            'username' => 'CHANGE_THIS_TO_DATABASE_USERNAME', //dont forget to CHANGE this
            'password' => 'CHANGE_THIS_TO_DATABASE_PASSWORD', //dont forget to CHANGE this
            'charset' => 'utf8',  
        ),
        'errorHandler' => array(
            // use 'site/error' action to display errors
            'errorAction' => 'site/error',
        ),
        'log' => array(
            'class' => 'CLogRouter',
            'routes' => array(
                array(
                    'class' => 'CWebLogRoute',
                    // 'class' => 'CFileLogRoute',
                    'levels' => 'error, warning',
                ),
            // uncomment the following to show log messages on web pages
            /*
              array(
              'class'=>'CWebLogRoute',
              ),
              array(
              'class'=>'CEmailLogRoute',
              'levels'=>'error',
              'emails'=>'peter_jackson@gmail.com',
              ),
             */
            ),
        ),
    ),
    // application-level parameters that can be accessed
    // using Yii::app()->params['paramName']
    'params' => array(
        // this is used in contact page
        'adminEmail' => 'webmaster@example.com',
    ),
);

Save the file by pressing ctrl + s and close the file.

  1. Execute notepad console.php , notepad should open then paste this configuration code
<?php

// This is the configuration for yiic console application.
// Any writable CConsoleApplication properties can be configured here.
return array(
	'basePath' => dirname(__FILE__) . DIRECTORY_SEPARATOR . '..',
	'name' => 'CHANGE THIS TO YOUR LIKINGS',
	'import' => array(
		'ext.YiiMailer.YiiMailer',
	),
	// application components
	'components' => array(
		// uncomment the following to use a MySQL database
        'db'=>array(
            'connectionString' => 'mysql:host=localhost;dbname=DATABASE',
            'emulatePrepare' => true,
            'username' => 'DB_USERNAME_CHANGE_THIS', //dont forget to CHANGE this
            'password' => 'DB_PASSWORD_CHANGE_THIS', //dont forget to CHANGE this
            'charset' => 'utf8',  
        ),
	),
	'modules'=>array(
        'user'=>array(
                'tableUsers' => 'users',
                'tableProfiles' => 'profiles',
                'tableProfileFields' => 'profiles_fields',
        ),
	)
);

Save that and close the file. 8. The rest of installation should be smooth by clicking installUserAndRightsModule.bat. If prompted for confirmation just press y then enter . If prompted to set admin account , specify username and password you can use fake email for email admin . 9. Now go to the project and look for start.bat . Double click that to start the mini web server. 10. Open your browser and type localhost:8000

Tip and info :

  • Make sure WAMP or XAMP is turned on
  • Make sure to remember your username/password after executing installUserAndRightsModule.bat . If you cant remember your account just delete the whole database and double click installUserAndRightsModule.bat

FAQ

== How to allocate or register an available tomb ==
  1. Login as admin
  2. Go to http://localhost:8000/index.php/slot/addAvailable
  3. Select region
  4. Tombname . Example . A1 , A2 , A3
  5. Click add marker
  6. You can zoom in the map by scrolling in to the map.
  7. If you are sure of everything. Save

== How to register a dead person to a tomb ==

  1. Login as admin
  2. Go to http://localhost:8000/index.php/slot/register
  3. Enter person details (the dead person not you)
  4. Select tomb by clicking Show Available Tombs
  5. Click the marker to submit the record.

== How to register a dead person to a tomb ==

  1. Login as admin
  2. Go to http://localhost:8000/index.php/slot/search
  3. Search the person
  4. Click search
  5. You should see where the tomb is located

If you found any error (Im sure there are plenty) , Feel free to create an issue here https://github.com/kevindaus/tomblocator/issues together with the screenshot of the error.

V1.0.0 - First release

  • Base feature is added