If you have any questions that are beyond the scope of this help file, please do not hesitate to contact me via my Support Center.
I am always happy to help if you have any questions relating to Reside.
Reside's update has taken me many months to complete as most of my previous buyers know. I put a ton of love into this version, and added as many features as I could. Did I get every feature buyers requested? No, some features were taking more time to figure out on how to add, or just would not work as expected. I really wanted to add in some type of cron job that would automatically send emails to tenants with late rent, but after working on it for several weeks, I abondand the feature to add in at another time. I would love to see auto-sent emails, but it was just taking to much time, and delaying Reside that much more.
Reside does now have a full front-end where guests can view available properties and download the rental application. I put a lot of work and love into the front-end, and hope all my buyers like it as much as I do.
If you have any questions or would like to give me feed-back on Reside's update, I would love to hear them. Your feed-back is what inspires new ideas for future updates. You can post your questions/feed-back on Reside's Forum at my Support Center.
As always, a BIG Thank You to all of my buyers, I really appreciate your continued support & trust in me.
Unzip the Reside file and take a look at the file structure. You should see 13 folders and 10 files.
First step is to create a MySQL database, and if you do not have a default one, a database user. This process is explained in great detail on many websites and web hosts. Once you have the database setup, you will need:
Upload all the files you unzipped to your webhost, keeping the file system intact.
You should now have the following folders/files on your host account:
Installation is quite easy and only takes a few minutes.
Once Reside has finished uploading, simply go to http://www.yoursite.com/reside/ (or wherever sub-folder you uploaded it to) and follow the on-screen instructions.
Easy to do, just follow the defaults and plug in your specific information.
Reside REQUIRES PHP 5.3+ & MySQLi Connection, mcrypt_encrypt / mcrypt_decrypt and imagecreatefrompng (PNG Image Support).
There is a Server Configuration Check that will display before you will be able to install Reside. If all checks out, great, click the button "Start the Installation". If not, you will not see the "Start the Installation" button and will not be able to install Reside. Check with you host, and see if there is anything they can do for you.
Once you have input your database information, click on the "On to Step 2" button.
If everything was configured correctly, you will see the following:
If you do not see the message above, and get a blank screen or an error - check your error logs. Most of the time this happens due to your web account/host not supporting a needed function. This can happen even if you pass the pre-installation check. Check with your web host and see if there is any thing they can do to help.
Again, follow the defaults and plug in your site's specific information. You can set your Administrator username, password and Site name to be anything you would like. Once completed, be sure to hit "On to Step 3" to save your settings.
*If the Installation URL is not auto-filled, you will need to enter it manually.
Include any sub-folder Reside may be installed in. (ie. http://www.mydomain.com/reside/)
Look at your browser's URL bar, and use that (remove the install/install.php from the end) as your Installation URL.
Complete the Primary Admin Account form. This is the main, "Superuser" for Reside. This Admin Account cannot be deleted through the web UI, only from within the database (ie. PHPMyAdmin).
Once you have filled in the information for the Primary Admin, click the "Complete Install" button to complete the installation.
Once installation is completed, you will need to go back into your FTP application, and either rename or Delete the installation folder before you can log in as Administrator.
Once Reside is installed, you can update the Site Settings after logging in as the Primary Admin. Go to Site Settings page from the Manage dropdown menu.
These are the Global Settings that are used throughout Reside.
PayPal supports the following Currency Codes: USD, AUD, CAD, CZK, DKK, EUR, HKD, ILS, MXN, NOK, NZD, PHP, PLN, GBP, SGD, SEK, CHF, and THB
The Service Request Settings allow you to add, edit and delete Service Request Options. These are the options that populate the drop-downs.
I have included some basic examples on install.
The Home Page Slider Settings allows you to upload images for display on the home page.
I have included the ability to modify the content/text through the Admin interface. Under the "Manage" drop-down is an option for "Site Content". There you can easily modify the different page content used throughout Reside's front end. The content areas are located on the following pages:
I have included some basic examples on install, and you can modify this as needed. Some basic HTML is allowed, and if you want to use some margins &
paddings see the classes in the
css/styles.css file — Lines 1 through 39.
This is one of my first attempts at limiting what Administrators/Managers can access. Go to the "Admin Authorizations" link from the Admins drop-down:
Select an Administrator from the drop-down, and then click "Load Admin". The Admin's basic information will be displayed and current Authorizations will be checked. You can then modify the admin as needed. Save your changes. If you wish to load a new Admin, you will first need to clear any data that is currently being displayed.
If this is your first time using Reside, you do not need to do anything special. The Export/Import feature will not effect Reside in any way.
In Reside V.3, I have included an export/import feature to make transferring your data to the new version as easy as possible. Keep in mind you can only import limited types of data, specifically Tenants, Properties, Payments, Refunds, Service Requests and Admins/Managers. Also, If you choose to import your old data, you will need to do this BEFORE you add any new data through Reside. Once you have added any Tenants, Properties, Payments, Refunds, Service Requests or Admins/Managers, you will no longer be able to import your old data. This is to prevent duplicate ID's in the database.
In the zip file you downloaded from CodeCanyon, you will find a folder named "Export Reside V2 Data". Inside of that folder is the "export" folder you will need to upload to your current version of Reside. Upload it to the main, parent folder.
Once you have uploaded the export folder, complete the export process. Go to your current install of Reside
(ie. http://mydomain.com/reside-v2) and type in "/export" to the end of the URL (ie. http://mydomain.com/reside_v2/export). You should see the following:
Click on each of the Export Buttons for the data you want to export. You will get a prompt to either save, or open the CSV File. Save the file to a location on your computer. You will then upload these CSV files to the new version (V.3) of Reside. You do not have to export all data, you may just want to export your Tenants and nothing else. You can export/import as much data as you need. If you are familiar with CSV files, you could also adjust the exports to your needs. The CSV files the export produces DO NOT have any column headers. Just keep that in mind should you decide to edit the files before importing them into the new version.
Reside is translation ready. The primary Localization files are located in the folder named
language/. If you want to use a different language other then English, you will need to
translate the "custom.php" file. Once translated, you can then load that file via the Global Site Settings — Localization drop-down.
To change the way dates are formatted, you will need to modify the includes/functions.php file. Follow the instructions starting on line 42.
Uncomment (remove the double slash - //) from the date format you want to use
Comment (Add a double slash - //) to the front of the date formats you do NOT want to use
Reside supports numerous Currency Formats. You again, will need to edit the localization file you are using. On line 19, change the
$currCode to that of the 3 digit Currency Code you want to use.
Reside supports the following 3 Digit Currency Codes:
The dataTables Table Tools Plug-in will also need to be translated. I have tried to make this as easy as possible, moving all of the text that the plug-in uses to a separate include file — "tableTools.php". You can find this file in the main js folder:
Translate lines 9 through 18 just as you did in the language file. Do NOT modify any other code in this file.
The PayPal Class will also need to be translated. You can find the PayPal file named "paypal.php" in the includes folder:
Translate lines 8 through 10. Do NOT modify any other code in this file.
The Payment Receipt is sent using a Template. The template "receipt_tmpl.php" file can be found in the
Follow the instructions at the top of the file.
In this example, you can edit the text "Payment ID#" and the "Date Received". Do NOT edit the text in the double brackets. ie.
The Admin Authorization js file will also need to be translated. The file "adminAuths.js" can be found in the
Again, follow the instructions at the top of the file.
While Reside already has a modern interface based on Twitter's Bootstrap (version 3.3.4), many of you will want to integrate it into your own design. This is very easy, however, you will need to be able to write HTML/CSS code. For those that aren't versed, here is a quick overview. The easiest way to change the look is by editing the default CSS files named "styles.css" and "custom.css". Both of these files can be found in the css folder.
The bootstrap.css file is the original, unmodified Bootstrap styles, and you should not alter this file. If you want to make any changes to the bootstrap components, you should add the changes to the custom.css file only.
Reside uses a few images for the different logos and page background.
images/bg.png (400px x 400px)
images/logo.png (169px x 35px)
images/signin-logo.png (300px x 60px)
images/captcha.png (125px x 32px)
The icons used in the sorting images for all dataTables are located in
Icons are generated from an Icon Font: Font Awesome (version 4.3.0). Check out all of Font Awesome's icons & usage at: http://fontawesome.io.
You can now upload bulk images for your properties, up to 20 at a time. I have also included a "Featured" image for properties, that will be displayed as the preview image. You can also set a property to be "Featured", and doing this causes the property to have a featured ribbon across the preview image and to be displayed on the home page when it does not have an active lease. Properties with active leases will not be visible on the front-end.
If you have a building of rental units, you can add these properties just as you would any other property. Just add the unit number to the Properties name. ie. Westside Flat 105 or Westside 105. I have included a rental building in the demo if you would like to see how I did this. Two of the apartments are available, and 1 is rented.
You can upload documents for a property. These documents will be visible to all tenants and residents that lease the property. I would not suggest uploading documents to a property that contain tenant personal information. Keep in mind this feature is meant to be used as a repository for property files.
To lease a property, you must have a tenant to lease it to. Create your new tenant account (or have the tenant self-register if you have it enabled). You can set the lease for as long as you need.
There are 2 types of user accounts: Tenants & Residents. Tenants are the primary Tenant, that can be assigned a Lease/Property. Residents live with the Tenant, and are assigned to the property after the lease has been created. Both Tenants and Residents have their own log in, and can access information and Service Request for their assigned/Leased property.
If you want to completely disable a User's account and prevent them from signing in without deleting any of the data you have for that user, you can set the User's account to disabled. Navigate to the users account when logged in as an Admin with Manage User permissions. On the "Account Status" tab there is an option to Disable Account. Set it to "Yes", save your changes and the tenant will not longer be able to log in.
You can upload documents for a tenant/resident. These documents will be visible to only the tenant/resident they are uploaded for. These documents can be uploaded through the tenant/resident's profile.
If a Tenant submits a payment through PayPal, you will get a few emails. One from PayPal, and one from Reside. Once you receive the emails, and confirm that the payment has been received you will then need to record the payment manually into Reside. Reside will NOT record the payment for you.
When importing payments and refunds, the Payment's Year will be estimated based on the date the payment was recorded. If the payment was a rental payment, you may need to view the payment details, and update the Year the rent payment was for. There is no way to work around this, due to Reside V.2 not capturing the year.
The social icons on the front end can be set in the Settings — Social Networks. Only the social icons that you set a URL for will be displayed. This is also true for Admins/Managers. Admins/Managers can set their social links in their profile.
The phone number in the header and the address in the footer on the front-end is set in the Settings — Site Settings.
When setting the google maps url for properties and in the Settings — Site Settings, do NOT include the
<iframe> or any of the attributes. Just the URL is needed for the map to display correctly:
the URL should look similar to this:
You can get the url by going to http://maps.google.com and finding the address you want to add. Next click on the menu icon:
Next click on the Share or embed map link:
Click on the Embed map tab:
Copy the URL from the Embed map pop-up. This is the URL you will need to add to Reside. Again, do NOT include the
<iframe> or any of the attributes.
<iframe src="mapURL" width="600" height="450" frameborder="0" style="border:0" allowfullscreen></iframe> Just the base map URL — found in the
iframe src="" between the two double-quotes.
Please, if you have any questions, run into any issues or just need some help, do not hesitate to contact me via my Support Center.
I believe in providing the best support possible, and I monitor my Support center just about 24/7.
If you are thinking of giving Reside anything less then 5 Stars, please tell me what I can do to make it a 5 Star experience for you.
I love to hear feedback, and welcome any suggestions you may have to make Reside better.
If you are having problems with Reside after successfully installing and logging in the for the first time you should check your FTP software settings. I have found in many cases that numerous FTP programs are not uploading files correctly.
Check your FTP program to see if it is uploading files in ASCII - which is causing the file code to be uploaded in one long line.
Try changing it to Binary and uploading the files again. Upload everything except the install folder and the config file (or better yet, if you have not started using Reside, just wipe the install and the database and reinstall a fresh copy).
I use CuteFTP for my uploads and ran into this problem when all of the sudden everything I was working on just seemed to stop working as expected.