mirror of
https://github.com/itflow-org/itflow
synced 2026-03-27 07:45:37 +00:00
Fix readme typos/slight rewording
This commit is contained in:
40
README.md
40
README.md
@@ -1,4 +1,4 @@
|
|||||||
## IT Documentation Accounting and Invoicing System for Small MSPs.
|
## IT Documentation, Accounting and Invoicing System for Small MSPs.
|
||||||
|
|
||||||
### Online Demo
|
### Online Demo
|
||||||
|
|
||||||
@@ -7,20 +7,22 @@
|
|||||||
* PASSWORD: demo
|
* PASSWORD: demo
|
||||||
|
|
||||||
### Notice
|
### Notice
|
||||||
This project is still in early Beta stages and is considered work in progress we highly do not recommend storing any confiential information like passwords in ITFlow. Many changes are being permformed and may cause breakage upon updates. We are hoping to have a stable 1.0 release by July 2022.
|
* This project is still in early Beta stages and is considered a **work in progress**. Many changes are being performed and may cause breakage upon updates.
|
||||||
|
* We strongly recommend against storing confidential information like passwords in ITFlow at this time.
|
||||||
|
* We are hoping to have a stable 1.0 release by July 2022.
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
* Client Documentation
|
* Client Documentation
|
||||||
* Contacts - Keep track of important individuals
|
* Contacts - Keep track of important individuals
|
||||||
* Locations (Head Quarters, Satellite locations)
|
* Locations (Head Quarters, Satellite locations)
|
||||||
* Vendors (ISP, WebHost, MailHost, Software Company, VOIP company etc)
|
* Vendors (ISP, WebHost, MailHost, Software Company, VOIP company, etc.)
|
||||||
* Assets (Laptop, Workstations, Routers, Switches, Access Points, phones, etc)
|
* Assets (Laptop, Workstations, Routers, Switches, Access Points, phones, etc.)
|
||||||
* Password Manager (AES Encrypted in DB)
|
* Password Manager (AES Encrypted in database)
|
||||||
* Domain Names
|
* Domain Names & SSL Certificates
|
||||||
* Software (Manage Applications Licenses, Renewals etc)
|
* Software (Manage Applications Licenses, Renewals etc.)
|
||||||
* Networks
|
* Networks
|
||||||
* Files (PDF Contracts, Manuals, Firewall Backup Configs, etc)
|
* Files (PDF Contracts, Manuals, Firewall Backup Configs, etc.)
|
||||||
* Documents (Tech Docs, How-tos, Processes, Procedures, Notes, etc)
|
* Documents (Tech Docs, How-tos, Processes, Procedures, Notes, etc.)
|
||||||
* Tickets
|
* Tickets
|
||||||
* Client Documentation (Single Downloadable IT Documentation for a client)
|
* Client Documentation (Single Downloadable IT Documentation for a client)
|
||||||
* Client Portal
|
* Client Portal
|
||||||
@@ -34,12 +36,12 @@ This project is still in early Beta stages and is considered work in progress we
|
|||||||
* Automated customer approval process using a link that is sent via email to the primary contact
|
* Automated customer approval process using a link that is sent via email to the primary contact
|
||||||
* One Click turn Quotes into Invoices
|
* One Click turn Quotes into Invoices
|
||||||
* Accounting
|
* Accounting
|
||||||
* Expense Tracking (Track internal business expenses such as Office Supplies, Professional Services, Equipment, etc)
|
* Expense Tracking (Track internal business expenses such as Office Supplies, Professional Services, Equipment, etc.)
|
||||||
* Profit and Loss Reports
|
* Profit and Loss Reports
|
||||||
* Income/Expense Summaries
|
* Income/Expense Summaries
|
||||||
* Travel Mileage Tracking
|
* Travel Mileage Tracking
|
||||||
* Accounts (Manage several accounts including cash on hand, bank accounts, etc)
|
* Accounts (Manage several accounts including cash on hand, bank accounts, etc.)
|
||||||
* Account Transfers (Keep track of money transfers from account to account inclusing deposits)
|
* Account Transfers (Keep track of money transfers from account to account including deposits)
|
||||||
* Alerting/Notifications
|
* Alerting/Notifications
|
||||||
* Low Account Balances
|
* Low Account Balances
|
||||||
* Domains to expire
|
* Domains to expire
|
||||||
@@ -48,12 +50,12 @@ This project is still in early Beta stages and is considered work in progress we
|
|||||||
* Software License Expiration
|
* Software License Expiration
|
||||||
* Calendar
|
* Calendar
|
||||||
* Schedule Jobs
|
* Schedule Jobs
|
||||||
* Overview of Invoices, Domains, asset Warranty Expiry, etc
|
* Overview of Invoices, Domains, Asset Warranty Expiry, etc.
|
||||||
* Schedule Events
|
* Schedule Events
|
||||||
* Automatic Email Reminders of upcoming calendar events to customers
|
* Automatic Email Reminders of upcoming calendar events to customers
|
||||||
* Dashboard
|
* Dashboard
|
||||||
* Overview of business financials
|
* Overview of business financials
|
||||||
* Mailing List - Notify users of upcoming change controls, marketing etc
|
* Mailing List - Notify users of upcoming change controls, marketing, etc.
|
||||||
|
|
||||||
* API
|
* API
|
||||||
* XML Phonebook download for VOIP Phones
|
* XML Phonebook download for VOIP Phones
|
||||||
@@ -75,18 +77,18 @@ This project is still in early Beta stages and is considered work in progress we
|
|||||||
* Point your browser to your Web Server
|
* Point your browser to your Web Server
|
||||||
* Go through the Setup Process
|
* Go through the Setup Process
|
||||||
* Login
|
* Login
|
||||||
* Start inputing some data
|
* Start inputting some data
|
||||||
|
|
||||||
#### Requirements
|
#### Requirements
|
||||||
* Webserver (Apache, NGINX)
|
* Webserver (Apache, NGINX)
|
||||||
* PHP7+
|
* PHP7+
|
||||||
* MariaDB (MySQL is broke)
|
* MariaDB (MySQL is broken)
|
||||||
|
|
||||||
### Technologies Used
|
### Technologies Used
|
||||||
* Backend / PHP libs
|
* Backend / PHP libs
|
||||||
* PHP
|
* PHP
|
||||||
* MariaDB
|
* MariaDB
|
||||||
* PHPmailer
|
* PHPMailer
|
||||||
|
|
||||||
* CSS
|
* CSS
|
||||||
* Bootstrap
|
* Bootstrap
|
||||||
@@ -96,7 +98,7 @@ This project is still in early Beta stages and is considered work in progress we
|
|||||||
* JS Libraries
|
* JS Libraries
|
||||||
* chart.js
|
* chart.js
|
||||||
* moments.js
|
* moments.js
|
||||||
* Jquery
|
* jQuery
|
||||||
* pdfmake
|
* pdfmake
|
||||||
* Select2
|
* Select2
|
||||||
* SummerNote
|
* SummerNote
|
||||||
@@ -106,7 +108,7 @@ This project is still in early Beta stages and is considered work in progress we
|
|||||||
* Caller ID lookup (Great for integrating with your phone system like FreePBX, and having your VOIP phone return the client's name thats calling in) - /api.php?api_key=[API_KEY]&cid=[PHONE_NUMBER] - Returns a name
|
* Caller ID lookup (Great for integrating with your phone system like FreePBX, and having your VOIP phone return the client's name thats calling in) - /api.php?api_key=[API_KEY]&cid=[PHONE_NUMBER] - Returns a name
|
||||||
* XML Phonebook Download - /api.php?api_key=[API_KEY]&phonebook
|
* XML Phonebook Download - /api.php?api_key=[API_KEY]&phonebook
|
||||||
* Client Email (great for mailing lists) - /api.php?api_key=[API_KEY]&client_emails - Returns Client Name - Email Address
|
* Client Email (great for mailing lists) - /api.php?api_key=[API_KEY]&client_emails - Returns Client Name - Email Address
|
||||||
* Account Balance for Client (can be integrated into multiple places for example in FreePBX Press 3 to check account balance, please enter your client ID your blanace is) - /api.php?api_key=[API_KEY]&client_id=[CLIENT_ID] - Returns Account Balance
|
* Account Balance for Client (can be integrated into multiple places for example in FreePBX Press 3 to check account balance, please enter your client ID your balance is) - /api.php?api_key=[API_KEY]&client_id=[CLIENT_ID] - Returns Account Balance
|
||||||
NOTE: [API_KEY] - is auto generated when a company is created and shows up in General Settings, this can also be changed manually.
|
NOTE: [API_KEY] - is auto generated when a company is created and shows up in General Settings, this can also be changed manually.
|
||||||
|
|
||||||
### Future Todo
|
### Future Todo
|
||||||
|
|||||||
Reference in New Issue
Block a user