Giter VIP home page Giter VIP logo

client-manager's Introduction

Client management module.

Designed for service based small enterprise.

Use this module to manage time keeping, invoicing, payments, reporting for your staff and your clients.

Requires Seriti Slim 3 MySQL Framework skeleton

This module integrates seamlessly into Seriti skeleton framework.
You need to first install the skeleton framework and then download the source files for the module and follow these instructions.

It is possible to use this module independantly from the seriti skeleton but you will still need the Seriti tools library.
It is strongly recommended that you first install the seriti skeleton to see a working example of code use before using it within another application framework.
That said, if you are an experienced PHP programmer you will have no problem doing this and the required code footprint is very small.

Install the module

1.) Install Seriti Skeleton framework(see the framework readme for detailed instructions) :
composer create-project seriti/slim3-skeleton [directory-for-app].
Make sure that you have thsi working before you proceed.

2.) Download a copy of Client manager module source code directly from github and unzip,
or by using git clone https://github.com/seriti/client-manager from command line.
Once you have a local copy of module code check that it has following structure:

/Clients/(all module implementation classes are in this folder)
/setup_app.php
/routes.php
/templates/(all templates for module)

3.) Copy the Clients folder and all its contents into [directory-for-app]/app folder.

4.) Open the routes.php file and insert the $this->group('/client', function (){} route definition block within the existing $app->group('/admin', function () {} code block contained in existing skeleton [directory-for-app]/src/routes.php file.

5.) Open the setup_app.php file and add the module config code snippet into bottom of skeleton [directory-for-app]/src/setup_app.php file. Please check the table_prefix value to ensure that there will not be a clash with any existing tables in your database.

6.) Copy the contents of templates folder to [directory-for-app]/templates/ folder

7.) Now in your browser goto URL:

http://localhost:8000/admin/client/dashboard if you are using php built in server
OR
http://www.yourdomain.com/admin/client/dashboard if you have configured a domain on your server
OR Click Dashboard menu option and you will see list of available modules, click Client manager

Now click link at bottom of page Setup Database: This will create all necessary database tables with table_prefix as defined above.
Thats it, you are good to go. Add some clients, capture some timesheets, generate some invoices, view reports.

NB: To customise the invoice PDF you need to use existing seriti skeleton customise module.
You can also use the same customise module to add Client module routes to application menu.

client-manager's People

Contributors

seriti avatar

Stargazers

Shubhra Prakash Paul avatar

Watchers

 avatar

Forkers

shuvro-zz

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.