base on A Laravel and Filament-powered accounting platform, crafting a modern and automated solution for financial management. # ERPSAAS <a href="https://trendshift.io/repositories/4749" target="_blank"><img src="https://trendshift.io/api/badge/repositories/4749" alt="andrewdwallo%2Ferpsaas | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a> <img width="1920" alt="Create Company" src="https://github.com/andrewdwallo/erpsaas/assets/104294090/5146c4db-dffc-4207-9095-2ebb80d452e1"> <img width="1920" alt="Invoice" src="https://github.com/andrewdwallo/erpsaas/assets/104294090/d7115830-6912-4267-ab54-17f7dbcc21cd"> <img width="1920" alt="Plaid" src="https://github.com/andrewdwallo/erpsaas/assets/104294090/c85862ac-62ff-4c0d-9b2a-f7393ad977ef"> <img width="1920" alt="Connected Accounts" src="https://github.com/andrewdwallo/erpsaas/assets/104294090/3a4deebc-528c-4b84-91db-9f0515de883d"> <img width="1920" alt="Transactions" src="https://github.com/andrewdwallo/erpsaas/assets/104294090/c50a899d-ee6f-4300-92a9-4a41c5433972"> <img width="1906" alt="Screenshot 2024-12-08 at 3 05 30 AM" src="https://github.com/user-attachments/assets/360f652a-5c61-4ae5-9fa1-9d6f3627e229"> <img width="1906" alt="Balance Sheet Report" src="https://github.com/user-attachments/assets/01b112d0-f9d6-4835-aca1-245c1a17830f"> <img width="1906" alt="Trial Balance Report" src="https://github.com/user-attachments/assets/b43beb9d-7e2c-413c-a7c5-8ab987885cae"> <img width="1906" alt="Account Transactions Report" src="https://github.com/user-attachments/assets/527bb3c9-4918-49c4-9be3-769e07e57a82"> <img width="1906" alt="Account Balances Report" src="https://github.com/user-attachments/assets/d8b28fcd-a9e2-4805-937c-dfd4d3848ce4"> This repo is currently a work in progress — PRs and issues welcome! # Getting started ## Installation Please check the official laravel installation guide for server requirements before you start. [Official Documentation](https://laravel.com/docs/10.x) Clone the repository git clone https://github.com/andrewdwallo/erpsaas.git Switch to the repo folder cd erpsaas Install all the dependencies using composer and npm composer install npm install Copy the example env file and make the required configuration changes in the .env file cp .env.example .env Generate a new application key php artisan key:generate Run the database migrations (**Set the database connection in .env before migrating**) php artisan migrate Build your assets & start the local development server php artisan filament:assets npm run build npm run dev **Command list** git clone https://github.com/andrewdwallo/erpsaas.git cd erpsaas composer install npm install cp .env.example .env php artisan key:generate php artisan migrate npm run build npm run dev ## Database seeding **You may populate the database to help you get started quickly** Open the DatabaseSeeder and set the property values as per your requirement database/seeders/DatabaseSeeder.php Default login information: email: [email protected] password: password Run the database seeder php artisan db:seed ***Note***: It's recommended to have a clean database before seeding. You can reset your database to a clean state at any point by running the following command: php artisan migrate:fresh ## Generating PDFs for Reports To generate PDFs for reports, the application uses Laravel Snappy. The Laravel Snappy package is already included in the application, but you need to install Wkhtmltopdf separately. ### Wkhtmltopdf Installation 1. **Download and install Wkhtmltopdf** - [Wkhtmltopdf Downloads](https://wkhtmltopdf.org/downloads.html) - Alternatively, if you are using Homebrew on macOS, you can install it using the following command: ```bash brew install wkhtmltopdf ``` 2. **Configure the binary paths** - If needed, you can change the paths to the Wkhtmltopdf binaries in the Snappy configuration file ( `config/snappy.php`). For detailed installation instructions, refer to the [Laravel Snappy documentation](https://github.com/barryvdh/laravel-snappy). ## Live Currency ### Overview This application offers support for real-time currency exchange rates. This feature is disabled by default. To enable it, you must first register for an API key at [ExchangeRate-API](https://www.exchangerate-api.com/). The application uses this service due to its generous provision of up to 1,500 free API calls per month, which should be enough for development and testing purposes. **Disclaimer**: There is no affiliation between this application and ExchangeRate-API. Once you have your API key, you can enable the feature by setting the `CURRENCY_API_KEY` environment variable in your `.env` file. ### Initial Setup After setting your API key in the `.env` file, it is essential to prepare your database to store the currency data. Start by running a fresh database migration: ```bash php artisan migrate:fresh ``` This ensures that your database is in the correct state to store the currency information. Afterward, use the following command to generate and populate the Currency List with supported currencies for the Live Currency page: ```bash php artisan currency:init ``` This command fetches and stores the list of currencies supported by your configured exchange rate service. ### Configuration Of course, you may use any service you wish to retrieve currency exchange rates. If you decide to use a different service, you can update the `config/services.php` file with your choice: ```php 'currency_api' => [ 'key' => env('CURRENCY_API_KEY'), 'base_url' => 'https://v6.exchangerate-api.com/v6', ], ``` Then, adjust the implementation of the `App\Services\CurrencyService` class to use your chosen service. ### Live Currency Page Once enabled, the "Live Currency" feature provides access to a dedicated page in the application, listing all supported currencies from the configured exchange rate service. Users can view available currencies and update exchange rates for their company's currencies as needed. ### Important Information - To use the currency exchange rate feature, you must first obtain an API key from a service provider. This application is configured to use a service that offers a free tier suitable for development and testing purposes. - Your API key is sensitive information and should be kept secret. Do not commit it to your repository or share it with anyone. - Note that API rate limits may apply depending on the service you choose. Make sure to review the terms for your chosen service. ## Automatic Translation The application now supports automatic translation, leveraging machine translation services provided by AWS, as facilitated by the [andrewdwallo/transmatic](https://github.com/andrewdwallo/transmatic) package. This integration significantly enhances the application's accessibility for a global audience. The application currently offers support for several languages, including English, Arabic, German, Spanish, French, Indonesian, Italian, Dutch, Portuguese, Turkish, and Chinese, with English as the default language. ### Configuration & Usage To utilize this feature for additional languages or custom translations: 1. Follow the documentation provided in the [andrewdwallo/transmatic](https://github.com/andrewdwallo/transmatic) package. 2. Configure the package with your preferred translation service credentials. 3. Run the translation commands as per the package instructions to generate new translations. Once you have configured the package, you may update the following method in the `app/Models/Setting/Localization.php` file to generate translations based on the selected language in the application UI: Change to the following: ```php public static function getAllLanguages(): array { return Languages::getNames(app()->getLocale()); } ``` ## Plaid Integration To integrate [Plaid](https://plaid.com/) with your application for enhanced financial data connectivity, you must first create an account with Plaid and obtain your credentials. Set your credentials in the `.env` file as follows: ```env PLAID_CLIENT_ID=your-client-id PLAID_CLIENT_SECRET=your-secret PLAID_ENVIRONMENT=sandbox # Can be sandbox, development, or production PLAID_WEBHOOK_URL=https://my-static-domain.ngrok-free.app/api/plaid/webhook # Must have /api/plaid/webhook appended ``` The `PLAID_WEBHOOK_URL` is essential as it enables your application to receive real-time updates on transactions from connected bank accounts. This webhook URL must contain a static domain, which can be obtained from services like ngrok that offer a free static domain upon signup. Alternatively, you may use any other service that provides a static domain. After integrating Plaid, you can connect your account on the "Connected Accounts" page and link your financial institution. Before importing transactions, ensure to run the following command to process the queued transactions: ```bash php artisan queue:work --queue=transactions ``` ## Testing This project includes testing using [Pest](https://pestphp.com/). The current test suite covers some reporting features and other core functionality. While it's not yet a fully comprehensive test suite, it provides a foundation for testing critical features. ### Setting Up the Testing Environment #### Create a testing database Ensure that you create a separate testing database named `erpsaas_test` in your database management system (e.g., MySQL). ```bash CREATE DATABASE erpsaas_test; ``` ### Running Tests The testing process automatically handles refreshing and seeding the test database with each test run, so no manual migration is required. For more information on how to write and run tests using Pest, refer to the official documentation: [Pest Documentation](https://pestphp.com/docs). ## Dependencies - [filamentphp/filament](https://github.com/filamentphp/filament) - A collection of beautiful full-stack components - [andrewdwallo/filament-companies](https://github.com/andrewdwallo/filament-companies) - A complete authentication system kit based on companies built for Filament - [andrewdwallo/transmatic](https://github.com/andrewdwallo/transmatic) - A package for automatic translation using machine translation services - [akaunting/laravel-money](https://github.com/akaunting/laravel-money) - Currency formatting and conversion package for Laravel - [squirephp/squire](https://github.com/squirephp/squire) - A library of static Eloquent models for common fixture data - [awcodes/filament-table-repeater](https://github.com/awcodes/filament-table-repeater) - A modified version of the Filament Forms Repeater to display it as a table. ***Note*** : It is recommended to read the documentation for all dependencies to get yourself familiar with how the application works. ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. ", Assign "at most 3 tags" to the expected json: {"id":"4749","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"