Repositories
Overview
If you have already set up your Laravel website and WHAM, you can proceed with the following sections to integrate additional repositories that serve specific purposes within the project structure.
Apart from the Laravel website and WHAM, the project relies on several other repositories, each fulfilling a distinct role within the system.
ECOM-API
ECOM-API is a RESTful API designed to manage trolleys, orders, and invoice emails. While there is no initial requirement to set up the ECOM API, if you want to, you can continue by following the setup guide, it's crucial to verify the API endpoint configuration in the .env file. Here are the relevant environment variables:
| Variable | Value | Description |
|---|---|---|
ECOM_API_ENABLED | true | Set to false to disable the ECOM API. |
ECOM_API_DOMAIN | http://ecom-api.gke.pre-prod.<region>.toolstation.dev | Pre-production ECOM API URL, update for local setup. |
ECOM_API_ENDPOINT_PREFIX | /api | ECOM API endpoint prefix used for calls. |
LINGO
LINGO, available at Toolstation/lingo, serves as a Product Information Management (PIM) and Content Management System (CMS) for the website. It manages products, categories, attributes, content, and language translations. Follow the setup guide for installation. Key features:
- Language strings are managed and updated through Lingo.
- The laravel-website VM runs an artisan command hourly to synchronize language strings:
php artisan language:makestrings. - Immediate regeneration and application of language strings are possible.
- The mega menu is also controlled through Lingo, fetched by the web VM hourly.
Cadence
Cadence serves as the API used by Lingo to access data in the toolstation and toolstation_web databases. The language strings data resides in the toolstation_web database. Refer to the setup guide for configuration details.
EXTRANET
EXTRANET is a legacy codebase that plays a crucial role in serving our warehouse software, internal dashboard, and core systems.
Conclusion
In this guide, we've outlined the integration of additional repositories crucial to the functioning of your Laravel website and WHAM setup. Ensure to follow the setup guides provided for each repository for a seamless integration process.