diff --git a/README.md b/README.md index 39af52c..1f6c47b 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,158 @@ -# README # +# Ready To Go Letters # -This README would normally document whatever steps are necessary to get your application up and running. +Ready To Go Letters is a credit repair and dispute management software designed to help credit repair organizations and consultants streamline the credit dispute process. -### What is this repository for? ### +------------------------------------------------------------------------ +## 🏗 Project Architecture -* Quick summary -* Version -* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo) + MainProject/ + │ + ├── src/ + │ ├── Controllers/ + │ └── Model/ + | └── Template/ + ├── Config/ + ├── webroot/ -### How do I get set up? ### -* Summary of set up -* Configuration -* Dependencies -* Database configuration -* How to run tests -* Deployment instructions -### Contribution guidelines ### +------------------------------------------------------------------------ + +## ⚙️ Requirements + +- PHP 7.4 +- MySQL 5.7 +- CakePHP 3 +- Xampp Control Panel 3.3 + +------------------------------------------------------------------------ + +## 🛠 Installation + +``` bash +git clone +cd + +add vendor which is added onedrive +``` + +### Database + +Import database script inside file location db>>rtg.zip + +------------------------------------------------------------------------ + +## ▶️ Running the Project + +Base API URL: http://localhost/{project-name}/ + + +------------------------------------------------------------------------ + +## 📄 Key Features +``` bash +1. Introduction +================================================ +Ready To Go Letters is a credit repair and dispute management software designed to help credit repair organizations and consultants streamline the credit dispute process. + +The system imports and processes credit report data from third-party credit monitoring services such as IdentityIQ and SmartCredit. Once the credit report information is retrieved, users can review, analyze, and identify inaccurate, unverifiable, or negative items that may require dispute actions. + +The platform allows users to create and manage disputes for the major credit bureaus, including TransUnion, Equifax, and Experian. Based on the selected dispute items and predefined templates, the system automatically generates customized dispute letters and supporting documents. +``` +``` bash + 2. Users and Roles +======================================= +a. Admin + Can create and manage Member accounts. + +b. Member + Manages day-to-day credit repair operations. + Can create and manage Client, Affiliate, and Employee accounts. + Reviews credit reports, manages disputes, and generates letters. +c. Client + +d. Affiliate + Refers potential clients to the organization. + +e. Employee + Can create and manage Client and Affiliate accounts. +======================================================= + + +``` + +``` bash + 3. User Hierarchy +====================== +Admin → Can create and manage Members. +Member → Can create and manage Clients, Affiliates, and Employees. +Employee → Can create and manage Clients and Affiliates. +============================================================ + +``` + +``` bash +4. Packages or Services +========================== +Members can generate different types of credit repair letters for their clients based on the selected service package. + +a. RTG Letter Generate + Standard credit dispute letter generation service. + Creates customized letters for credit bureaus and creditors. +b. Epic Velocity + Advanced credit repair letter package. + Provides specialized dispute strategies and letter templates. +c. Velocity + Credit repair letter generation package. + Includes dispute letters designed to assist with credit improvement efforts. + +``` +``` bash +4. Packages or Services +========================== +Members can generate different types of credit repair letters for their clients based on the selected service package. + +a. RTG Letter Generate + Standard credit dispute letter generation service. + Creates customized letters for credit bureaus and creditors. +b. Epic Velocity + Advanced credit repair letter package. + Provides specialized dispute strategies and letter templates. +c. Velocity + Credit repair letter generation package. + Includes dispute letters designed to assist with credit improvement efforts. + +``` +```bash +## Key Features + +1. Role based menus +2. Forms and packages +3. Generate Letters +4. V1, V2, V3 Report +5. Import Report files +6. Employee, Affiliate, Client +7. Reminder/ Task +8. Velocity +9. Epic Velocity +10. Ring Central integration +11. letter stream +12. subscription -- Current Off +13. automation +14. Credit score calculation +15. agreement +16. personalize your account +17. credit analysis/analyzer +18. payment set up -- Current Off +19. google drive/ dropbox +20. RTG Admin panel + +```` +```` bash +## Details Tutorials +https://drive.google.com/drive/folders/1g7A3FRMn47CeUHDFk7lcLIvyT70lMW7D -- RTG knowledge sharing video link + +``` -* Writing tests -* Code review -* Other guidelines -### Who do I talk to? ### -* Repo owner or admin -* Other community or team contact \ No newline at end of file