luxx
DOCUMENTATION
Thank you for purchasing Luxx!
Content
1. Installation link
2. Configuration link
3. Using the platform link 3.1 Contacts 3.2 Projects 3.3 Invoices
4. Finish link
5. Credits link
1. Installation
Attention: The required PHP version for the script is at least 7.0.0!





Installing the script to your web host or local machine is very simple. It has been made possible through the 'install.php' file that is included in the script files.

Unzip the downloaded files. The downloaded file should contain a folder with the documentation and a main folder with the main application files (Luxx Documentation and Luxx Files).



Make sure you copy the files from main application folder (Luxx Files) where you want to install the script.



Note that the installation process will create, edit and remove files from the machine. Please make sure have permission to the script to do this actions on the existing files from the computer. Make sure you give '777' permissions on the main and enclosing folders and files.

At the end, all the script files and folders, even if they're in a different folder, should have the '777' permission.


(On a local machine)


(In a web host server files)

Make sure this permission is applied to the enclosing folders and files as well.

Now go to the web browser and type the link to the application. For example, for the demo where you can see Luxx in action, the link that I needed to go to install the script was mouple.tk/demo/luxx

The main installation page should pop up. You will be prompted to complete an installation form with the details of your database and some personal details about the company that will be displayed on the invoices among with some platform configurations.

2. Configuration
After you successfully installed the script you can use it or you can continue to configure it to your preferences. Altough the installation process covered a big part of the configuration and the main configs have been already declared, you can modify the them anytime.

The 'config.php' is the file you are looking for. It is located in the applications files, in the config folder. Open it in any text editor and configure your needs.



Just make sure you save the file everytime you change something.

Next configuration is in the app scripts file. This modification if mandatory. You have to change the URL to your host URL. This file is located in 'public -> js -> application.js'. Change the variable URL to your URL of the host.

3. Using the platform
Great job! You are ready to use the application.

Firstly, register for an account by clicking the 'Create Your Account' button located on the landing page. Use a valid e-mail address, because the script will send an activation e-mail to the provided e-mail address to verify your that you have access to the e-mail account. Go to the inbox of the e-mail address and follow the link provided in the activation e-mail.

If that has been successfully done, you should be able to login to your newly created account.

3.1 Contacts
You will have 4 sections: Dashboard, Contacts, Projects and Invoices.
In the 'Contacts' section. You can find all your personal contacts, your clients, the developers and other contacts. It really depends on how you categorize them.

You can add your first contact by using the 'Add New Contact' button located in the right part of the screen.
To understand the system, keep in mind that the contacts are other accounts created on the platform. You can search the account to be added as a contact by e-mail address. So for example, people you have in your subordinate need to have an account in order for you to add them as a contact.



Like in the 'Projects' and 'Invoices' sections, the contacts in the 'Contacts' sections have multiple actions. Contacts can be deleted, you can change the category of the contact, you can create an invoice for this contact directly from this section or you can add the contact to a project as a worker, especially for developer contacts.



3.2 Projects
Creating your first project works like adding a new contact, instead you have to complete some fields with details about the project. When the project is created, you will have multiple actions associated to it.

You can create tasks assigned to the project and complete them if they have been completed or re-activate them.

Contacts can be added as workers to the project. This will be displayed in the workers section, in the right planel box that can be opened with the project workers button.



Of course, projects can be edited or deleted.

Projects will display some useful informations about them. Completed tasks out of total tasks, workers count, deadline countdown time, project income and project tasks progress.

3.3 Invoices
Invoices can be created for an existing contact or with custom details. Like the projects, they display useful informations about each of the invoice like invoice items, invoice items total value and due date.



Invoices can be deleted, edited or you can change their status to 'paid' from 'unpaid' and vice versa. Along these actions, you can open a right panel and manage the invoice items or add new items to it.
4. Finish
You covered all of the platform features along with every section available in the platform. You are now ready to experience the platform by yourself!

If you have problems regarding the platform or you want to submit some feedback to improve the Luxx script, you can send an e-mail to: contact.mouple@gmail.com
5. Credits