@fleetbase/storefront-engine 0.1.7 → 0.1.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (307) hide show
  1. package/.php-cs-fixer.php +29 -0
  2. package/LICENSE.md +16 -4
  3. package/README.md +106 -13
  4. package/app/adapters/addon-category.js +1 -1
  5. package/app/adapters/gateway.js +1 -1
  6. package/app/adapters/network.js +1 -1
  7. package/app/adapters/notification-channel.js +1 -1
  8. package/app/adapters/product-addon-category.js +1 -1
  9. package/app/adapters/product-addon.js +1 -1
  10. package/app/adapters/product-hour.js +1 -1
  11. package/app/adapters/product-store-location.js +1 -1
  12. package/app/adapters/product-variant-option.js +1 -1
  13. package/app/adapters/product-variant.js +1 -1
  14. package/app/adapters/product.js +1 -1
  15. package/app/adapters/store-hour.js +1 -1
  16. package/app/adapters/store-location.js +1 -1
  17. package/app/adapters/store.js +1 -1
  18. package/app/adapters/storefront.js +1 -1
  19. package/app/components/file-record.js +1 -1
  20. package/app/components/modals/add-store-hours.js +1 -1
  21. package/app/components/modals/add-store-to-category.js +1 -1
  22. package/app/components/modals/add-stores-to-network.js +1 -1
  23. package/app/components/modals/assign-driver.js +1 -1
  24. package/app/components/modals/create-first-store.js +1 -1
  25. package/app/components/modals/create-gateway.js +1 -1
  26. package/app/components/modals/create-network-category.js +1 -1
  27. package/app/components/modals/create-network.js +1 -1
  28. package/app/components/modals/create-new-variant.js +1 -1
  29. package/app/components/modals/create-notification-channel.js +1 -1
  30. package/app/components/modals/create-product-category.js +1 -1
  31. package/app/components/modals/create-store.js +1 -1
  32. package/app/components/modals/edit-network.js +1 -1
  33. package/app/components/modals/import-products.js +1 -1
  34. package/app/components/modals/incoming-order.js +1 -1
  35. package/app/components/modals/manage-addons.js +1 -1
  36. package/app/components/modals/order-ready-assign-driver.js +1 -1
  37. package/app/components/modals/select-addon-category.js +1 -1
  38. package/app/components/modals/share-network.js +1 -1
  39. package/app/components/modals/store-details.js +1 -1
  40. package/app/components/modals/store-form.js +1 -1
  41. package/app/components/modals/store-location-form.js +1 -1
  42. package/app/components/network-category-picker.js +1 -1
  43. package/app/components/order-card.js +1 -1
  44. package/app/components/schedule-manager.js +1 -1
  45. package/app/components/settings-container.js +1 -1
  46. package/app/components/store-selector.js +1 -1
  47. package/app/components/widget/customers.js +1 -1
  48. package/app/components/widget/orders.js +1 -1
  49. package/app/components/widget/storefront-metrics.js +1 -1
  50. package/app/controllers/application.js +1 -1
  51. package/app/controllers/customers/index.js +1 -1
  52. package/app/controllers/home.js +1 -1
  53. package/app/controllers/networks/index/network/customers.js +1 -1
  54. package/app/controllers/networks/index/network/index.js +1 -1
  55. package/app/controllers/networks/index/network/orders.js +1 -1
  56. package/app/controllers/networks/index/network/stores.js +1 -1
  57. package/app/controllers/networks/index/network.js +1 -1
  58. package/app/controllers/networks/index.js +1 -1
  59. package/app/controllers/orders/index.js +1 -1
  60. package/app/controllers/products/index/category/edit.js +1 -1
  61. package/app/controllers/products/index/category/new.js +1 -1
  62. package/app/controllers/products/index/category.js +1 -1
  63. package/app/controllers/products/index/index/edit.js +1 -1
  64. package/app/controllers/products/index/index.js +1 -1
  65. package/app/controllers/products/index.js +1 -1
  66. package/app/controllers/settings/api.js +1 -1
  67. package/app/controllers/settings/gateways.js +1 -1
  68. package/app/controllers/settings/index.js +1 -1
  69. package/app/controllers/settings/locations.js +1 -1
  70. package/app/controllers/settings/notifications.js +1 -1
  71. package/app/helpers/get-tip-amount.js +1 -1
  72. package/app/models/addon-category.js +1 -1
  73. package/app/models/gateway.js +1 -1
  74. package/app/models/network.js +1 -1
  75. package/app/models/notification-channel.js +1 -1
  76. package/app/models/product-addon-category.js +1 -1
  77. package/app/models/product-addon.js +1 -1
  78. package/app/models/product-hour.js +1 -1
  79. package/app/models/product-store-location.js +1 -1
  80. package/app/models/product-variant-option.js +1 -1
  81. package/app/models/product-variant.js +1 -1
  82. package/app/models/product.js +1 -1
  83. package/app/models/store-hour.js +1 -1
  84. package/app/models/store-location.js +1 -1
  85. package/app/models/store.js +1 -1
  86. package/app/routes/application.js +1 -1
  87. package/app/routes/customers/index/edit.js +1 -1
  88. package/app/routes/customers/index.js +1 -1
  89. package/app/routes/home.js +1 -1
  90. package/app/routes/networks/index/network/customers.js +1 -1
  91. package/app/routes/networks/index/network/index.js +1 -1
  92. package/app/routes/networks/index/network/orders.js +1 -1
  93. package/app/routes/networks/index/network/stores.js +1 -1
  94. package/app/routes/networks/index/network.js +1 -1
  95. package/app/routes/networks/index.js +1 -1
  96. package/app/routes/orders/index/edit.js +1 -1
  97. package/app/routes/orders/index/new.js +1 -1
  98. package/app/routes/orders/index/view.js +1 -1
  99. package/app/routes/orders/index.js +1 -1
  100. package/app/routes/products/index/category/edit.js +1 -1
  101. package/app/routes/products/index/category/new.js +1 -1
  102. package/app/routes/products/index/category.js +1 -1
  103. package/app/routes/products/index/index/edit.js +1 -1
  104. package/app/routes/products/index/index.js +1 -1
  105. package/app/routes/products/index.js +1 -1
  106. package/app/routes/settings/api.js +1 -1
  107. package/app/routes/settings/gateways.js +1 -1
  108. package/app/routes/settings/index.js +1 -1
  109. package/app/routes/settings/locations.js +1 -1
  110. package/app/routes/settings/notifications.js +1 -1
  111. package/app/serializers/addon-category.js +1 -1
  112. package/app/serializers/network.js +1 -1
  113. package/app/serializers/notification-channel.js +1 -1
  114. package/app/serializers/product-addon-category.js +1 -1
  115. package/app/serializers/product-variant.js +1 -1
  116. package/app/serializers/product.js +1 -1
  117. package/app/serializers/store-location.js +1 -1
  118. package/app/serializers/store.js +1 -1
  119. package/app/services/storefront.js +1 -1
  120. package/app/templates/customers/index/edit.js +1 -1
  121. package/app/templates/customers/index.js +1 -1
  122. package/app/templates/home.js +1 -1
  123. package/app/templates/networks/index/network/customers.js +1 -1
  124. package/app/templates/networks/index/network/index.js +1 -1
  125. package/app/templates/networks/index/network/orders.js +1 -1
  126. package/app/templates/networks/index/network/stores.js +1 -1
  127. package/app/templates/networks/index/network.js +1 -1
  128. package/app/templates/networks/index.js +1 -1
  129. package/app/templates/orders/index/edit.js +1 -1
  130. package/app/templates/orders/index/new.js +1 -1
  131. package/app/templates/orders/index/view.js +1 -1
  132. package/app/templates/orders/index.js +1 -1
  133. package/app/templates/products/index/category/edit.js +1 -1
  134. package/app/templates/products/index/category/new.js +1 -1
  135. package/app/templates/products/index/category.js +1 -1
  136. package/app/templates/products/index/index/edit.js +1 -1
  137. package/app/templates/products/index/index.js +1 -1
  138. package/app/templates/products/index.js +1 -1
  139. package/app/templates/settings/api.js +1 -1
  140. package/app/templates/settings/gateways.js +1 -1
  141. package/app/templates/settings/index.js +1 -1
  142. package/app/templates/settings/locations.js +1 -1
  143. package/app/templates/settings/notifications.js +1 -1
  144. package/app/templates/settings.js +1 -1
  145. package/app/utils/create-shareable-link.js +1 -1
  146. package/app/utils/get-gateway-schemas.js +1 -1
  147. package/app/utils/get-notification-schemas.js +1 -1
  148. package/composer.json +88 -0
  149. package/extension.json +10 -0
  150. package/package.json +6 -6
  151. package/phpstan.neon.dist +8 -0
  152. package/phpunit.xml.dist +16 -0
  153. package/server/.gitattributes +14 -0
  154. package/server/README.md +40 -0
  155. package/server/config/api.php +101 -0
  156. package/server/config/database.connections.php +57 -0
  157. package/server/config/storefront.php +19 -0
  158. package/server/config/twilio-notification-channel.php +36 -0
  159. package/server/migrations/2023_05_03_025307_create_carts_table.php +44 -0
  160. package/server/migrations/2023_05_03_025307_create_checkouts_table.php +51 -0
  161. package/server/migrations/2023_05_03_025307_create_gateways_table.php +48 -0
  162. package/server/migrations/2023_05_03_025307_create_network_stores_table.php +36 -0
  163. package/server/migrations/2023_05_03_025307_create_networks_table.php +56 -0
  164. package/server/migrations/2023_05_03_025307_create_notification_channels_table.php +43 -0
  165. package/server/migrations/2023_05_03_025307_create_payment_methods_table.php +44 -0
  166. package/server/migrations/2023_05_03_025307_create_product_addon_categories_table.php +38 -0
  167. package/server/migrations/2023_05_03_025307_create_product_addons_table.php +43 -0
  168. package/server/migrations/2023_05_03_025307_create_product_hours_table.php +37 -0
  169. package/server/migrations/2023_05_03_025307_create_product_store_locations_table.php +34 -0
  170. package/server/migrations/2023_05_03_025307_create_product_variant_options_table.php +40 -0
  171. package/server/migrations/2023_05_03_025307_create_product_variants_table.php +44 -0
  172. package/server/migrations/2023_05_03_025307_create_products_table.php +59 -0
  173. package/server/migrations/2023_05_03_025307_create_reviews_table.php +41 -0
  174. package/server/migrations/2023_05_03_025307_create_store_hours_table.php +37 -0
  175. package/server/migrations/2023_05_03_025307_create_store_locations_table.php +38 -0
  176. package/server/migrations/2023_05_03_025307_create_stores_table.php +57 -0
  177. package/server/migrations/2023_05_03_025307_create_votes_table.php +39 -0
  178. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_carts_table.php +40 -0
  179. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_checkouts_table.php +48 -0
  180. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_gateways_table.php +40 -0
  181. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_network_stores_table.php +40 -0
  182. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_networks_table.php +42 -0
  183. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_notification_channels_table.php +40 -0
  184. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_payment_methods_table.php +40 -0
  185. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_product_addon_categories_table.php +38 -0
  186. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_product_addons_table.php +38 -0
  187. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_product_hours_table.php +32 -0
  188. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_product_store_locations_table.php +34 -0
  189. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_product_variant_options_table.php +32 -0
  190. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_product_variants_table.php +32 -0
  191. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_products_table.php +44 -0
  192. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_reviews_table.php +38 -0
  193. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_store_hours_table.php +32 -0
  194. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_store_locations_table.php +40 -0
  195. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_stores_table.php +42 -0
  196. package/server/migrations/2023_05_03_025310_add_foreign_keys_to_votes_table.php +38 -0
  197. package/server/src/Auth/Schemas/Storefront.php +95 -0
  198. package/server/src/Console/Commands/NotifyStorefrontOrderNearby.php +86 -0
  199. package/server/src/Expansions/EntityExpansion.php +44 -0
  200. package/server/src/Http/Controllers/ActionController.php +119 -0
  201. package/server/src/Http/Controllers/AddonCategoryController.php +13 -0
  202. package/server/src/Http/Controllers/CustomerController.php +13 -0
  203. package/server/src/Http/Controllers/GatewayController.php +13 -0
  204. package/server/src/Http/Controllers/MetricsController.php +71 -0
  205. package/server/src/Http/Controllers/NetworkController.php +170 -0
  206. package/server/src/Http/Controllers/NotificationChannelController.php +13 -0
  207. package/server/src/Http/Controllers/OrderController.php +154 -0
  208. package/server/src/Http/Controllers/ProductAddonCategoryController.php +14 -0
  209. package/server/src/Http/Controllers/ProductAddonController.php +14 -0
  210. package/server/src/Http/Controllers/ProductController.php +123 -0
  211. package/server/src/Http/Controllers/ProductHourController.php +13 -0
  212. package/server/src/Http/Controllers/ProductVariantController.php +13 -0
  213. package/server/src/Http/Controllers/ProductVariantOptionController.php +13 -0
  214. package/server/src/Http/Controllers/ReviewController.php +13 -0
  215. package/server/src/Http/Controllers/StoreController.php +26 -0
  216. package/server/src/Http/Controllers/StoreHourController.php +13 -0
  217. package/server/src/Http/Controllers/StoreLocationController.php +13 -0
  218. package/server/src/Http/Controllers/StorefrontController.php +15 -0
  219. package/server/src/Http/Controllers/VoteController.php +13 -0
  220. package/server/src/Http/Controllers/v1/CartController.php +161 -0
  221. package/server/src/Http/Controllers/v1/CategoryController.php +138 -0
  222. package/server/src/Http/Controllers/v1/CheckoutController.php +957 -0
  223. package/server/src/Http/Controllers/v1/CustomerController.php +482 -0
  224. package/server/src/Http/Controllers/v1/GatewayControllerController.php +11 -0
  225. package/server/src/Http/Controllers/v1/NetworkController.php +281 -0
  226. package/server/src/Http/Controllers/v1/PaymentMethodController.php +11 -0
  227. package/server/src/Http/Controllers/v1/ProductController.php +94 -0
  228. package/server/src/Http/Controllers/v1/ReviewController.php +270 -0
  229. package/server/src/Http/Controllers/v1/ServiceQuoteController.php +402 -0
  230. package/server/src/Http/Controllers/v1/StoreController.php +176 -0
  231. package/server/src/Http/Filter/AddonCategoryFilter.php +19 -0
  232. package/server/src/Http/Filter/CustomerFilter.php +18 -0
  233. package/server/src/Http/Filter/GatewayFilter.php +13 -0
  234. package/server/src/Http/Filter/NetworkFilter.php +18 -0
  235. package/server/src/Http/Filter/NotificationChannelFilter.php +13 -0
  236. package/server/src/Http/Filter/OrderFilter.php +46 -0
  237. package/server/src/Http/Filter/ProductFilter.php +28 -0
  238. package/server/src/Http/Filter/StoreFilter.php +42 -0
  239. package/server/src/Http/Filter/StoreLocationFilter.php +23 -0
  240. package/server/src/Http/Middleware/SetStorefrontSession.php +130 -0
  241. package/server/src/Http/Requests/AddStoreToNetworkCategory.php +45 -0
  242. package/server/src/Http/Requests/CaptureOrderRequest.php +30 -0
  243. package/server/src/Http/Requests/CreateCustomerRequest.php +44 -0
  244. package/server/src/Http/Requests/CreateReviewRequest.php +34 -0
  245. package/server/src/Http/Requests/GetServiceQuoteFromCart.php +40 -0
  246. package/server/src/Http/Requests/InitializeCheckoutRequest.php +38 -0
  247. package/server/src/Http/Requests/NetworkActionRequest.php +43 -0
  248. package/server/src/Http/Requests/VerifyCreateCustomerRequest.php +31 -0
  249. package/server/src/Http/Resources/Cart.php +31 -0
  250. package/server/src/Http/Resources/Category.php +48 -0
  251. package/server/src/Http/Resources/Customer.php +36 -0
  252. package/server/src/Http/Resources/Gateway.php +32 -0
  253. package/server/src/Http/Resources/Media.php +29 -0
  254. package/server/src/Http/Resources/Network.php +48 -0
  255. package/server/src/Http/Resources/Product.php +209 -0
  256. package/server/src/Http/Resources/Review.php +45 -0
  257. package/server/src/Http/Resources/ReviewCustomer.php +60 -0
  258. package/server/src/Http/Resources/Store.php +76 -0
  259. package/server/src/Http/Resources/StoreHour.php +29 -0
  260. package/server/src/Http/Resources/StoreLocation.php +33 -0
  261. package/server/src/Imports/ProductsImport.php +20 -0
  262. package/server/src/Jobs/DownloadProductImageUrl.php +60 -0
  263. package/server/src/Listeners/HandleOrderCompleted.php +31 -0
  264. package/server/src/Listeners/HandleOrderDispatched.php +34 -0
  265. package/server/src/Listeners/HandleOrderDriverAssigned.php +37 -0
  266. package/server/src/Listeners/HandleOrderStarted.php +27 -0
  267. package/server/src/Mail/StorefrontNetworkInvite.php +48 -0
  268. package/server/src/Models/AddonCategory.php +30 -0
  269. package/server/src/Models/Cart.php +691 -0
  270. package/server/src/Models/Checkout.php +166 -0
  271. package/server/src/Models/Customer.php +88 -0
  272. package/server/src/Models/Gateway.php +165 -0
  273. package/server/src/Models/Network.php +300 -0
  274. package/server/src/Models/NetworkStore.php +86 -0
  275. package/server/src/Models/NotificationChannel.php +147 -0
  276. package/server/src/Models/PaymentMethod.php +99 -0
  277. package/server/src/Models/Product.php +315 -0
  278. package/server/src/Models/ProductAddon.php +128 -0
  279. package/server/src/Models/ProductAddonCategory.php +90 -0
  280. package/server/src/Models/ProductHour.php +59 -0
  281. package/server/src/Models/ProductStoreLocation.php +77 -0
  282. package/server/src/Models/ProductVariant.php +125 -0
  283. package/server/src/Models/ProductVariantOption.php +86 -0
  284. package/server/src/Models/Review.php +127 -0
  285. package/server/src/Models/Store.php +478 -0
  286. package/server/src/Models/StoreHour.php +59 -0
  287. package/server/src/Models/StoreLocation.php +126 -0
  288. package/server/src/Models/StorefrontModel.php +22 -0
  289. package/server/src/Models/Vote.php +84 -0
  290. package/server/src/Notifications/StorefrontOrderCanceled.php +196 -0
  291. package/server/src/Notifications/StorefrontOrderCompleted.php +201 -0
  292. package/server/src/Notifications/StorefrontOrderCreated.php +157 -0
  293. package/server/src/Notifications/StorefrontOrderDriverAssigned.php +200 -0
  294. package/server/src/Notifications/StorefrontOrderEnroute.php +199 -0
  295. package/server/src/Notifications/StorefrontOrderNearby.php +201 -0
  296. package/server/src/Notifications/StorefrontOrderPreparing.php +202 -0
  297. package/server/src/Notifications/StorefrontOrderReadyForPickup.php +202 -0
  298. package/server/src/Observers/NetworkObserver.php +40 -0
  299. package/server/src/Observers/ProductObserver.php +118 -0
  300. package/server/src/Providers/EventServiceProvider.php +23 -0
  301. package/server/src/Providers/StorefrontServiceProvider.php +103 -0
  302. package/server/src/Support/Metrics.php +193 -0
  303. package/server/src/Support/OrderConfig.php +13 -0
  304. package/server/src/Support/QPay.php +208 -0
  305. package/server/src/Support/Storefront.php +201 -0
  306. package/server/src/routes.php +180 -0
  307. package/server/tests/Feature.php +5 -0
@@ -0,0 +1,29 @@
1
+ <?php
2
+
3
+ $finder = PhpCsFixer\Finder::create()
4
+ ->in(__DIR__ . DIRECTORY_SEPARATOR . 'server' . DIRECTORY_SEPARATOR . 'tests')
5
+ ->in(__DIR__ . DIRECTORY_SEPARATOR . 'server' . DIRECTORY_SEPARATOR . 'src')
6
+ ->append(['.php-cs-fixer.php']);
7
+
8
+ $rules = [
9
+ '@Symfony' => true,
10
+ 'phpdoc_no_empty_return' => false,
11
+ 'array_syntax' => ['syntax' => 'short'],
12
+ 'yoda_style' => false,
13
+ 'binary_operator_spaces' => [
14
+ 'operators' => [
15
+ '=>' => 'align',
16
+ '=' => 'align',
17
+ ],
18
+ ],
19
+ 'concat_space' => ['spacing' => 'one'],
20
+ 'not_operator_with_space' => false,
21
+ 'increment_style' => ['style' => 'post'],
22
+ 'indentation_type' => true,
23
+ 'single_quote' => true,
24
+ ];
25
+
26
+ return (new PhpCsFixer\Config())
27
+ ->setUsingCache(true)
28
+ ->setRules($rules)
29
+ ->setFinder($finder);
package/LICENSE.md CHANGED
@@ -1,9 +1,21 @@
1
1
  The MIT License (MIT)
2
2
 
3
- Copyright (c) 2022
3
+ Copyright (c) 2023 Fleetbase
4
4
 
5
- Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
6
11
 
7
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
8
14
 
9
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,32 +1,125 @@
1
- # @fleetbase/storefront-engine
1
+ <p align="center">
2
+ <p align="center">
3
+ <img src="https://camo.githubusercontent.com/870812d4ebe999bd1434db7ffcb27c2f347f1c2c6af1842e59ae8b28855b4b42/68747470733a2f2f666c622d6173736574732e73332e61702d736f757468656173742d312e616d617a6f6e6177732e636f6d2f7374617469632f73746f726566726f6e742d6c6f676f2e737667" width="380" height="100" />
4
+ </p>
5
+ <p align="center">
6
+ Open-source Headless Commerce & Marketplace Extension for Fleetbase
7
+ </p>
8
+ </p>
2
9
 
3
- [Short description of the addon.]
10
+ ---
4
11
 
12
+ ## Overview
5
13
 
6
- ## Compatibility
14
+ This monorepo contains both the frontend and backend components of the Storefront extension for Fleetbase. The frontend is built using Ember.js and the backend is implemented in PHP.
7
15
 
8
- * Ember.js v3.24 or above
9
- * Ember CLI v3.24 or above
10
- * Node.js v14 or above
16
+ ### Requirements
11
17
 
18
+ - PHP 7.3.0 or above
19
+ - Ember.js v3.24 or above
20
+ - Ember CLI v3.24 or above
21
+ - Node.js v14 or above
12
22
 
13
- ## Installation
23
+ ## Structure
14
24
 
15
25
  ```
16
- ember install @fleetbase/storefront-engine
26
+ ├── addon
27
+ ├── app
28
+ ├── assets
29
+ ├── translations
30
+ ├── config
31
+ ├── node_modules
32
+ ├── server
33
+ │ ├── config
34
+ │ ├── data
35
+ │ ├── migrations
36
+ │ ├── resources
37
+ │ ├── src
38
+ │ ├── tests
39
+ │ └── vendor
40
+ ├── tests
41
+ ├── testem.js
42
+ ├── index.js
43
+ ├── package.json
44
+ ├── phpstan.neon.dist
45
+ ├── phpunit.xml.dist
46
+ ├── pnpm-lock.yaml
47
+ ├── ember-cli-build.js
48
+ ├── composer.json
49
+ ├── CONTRIBUTING.md
50
+ ├── LICENSE.md
51
+ ├── README.md
52
+ ```
53
+
54
+ ## Installation
55
+
56
+ ### Backend
57
+
58
+ Install the PHP packages using Composer:
59
+
60
+ ```bash
61
+ composer require fleetbase/core-api
62
+ composer require fleetbase/fleetops
63
+ composer require fleetbase/storefront
17
64
  ```
65
+ ### Frontend
18
66
 
67
+ Install the Ember.js Engine/Addon:
68
+
69
+ ```bash
70
+ pnpm install @fleetbase/storefront
71
+ ```
19
72
 
20
73
  ## Usage
21
74
 
22
- [Longer description of how to use the addon in apps.]
75
+ ### Backend
76
+
77
+ 🧹 Keep a modern codebase with **PHP CS Fixer**:
78
+ ```bash
79
+ composer lint
80
+ ```
23
81
 
82
+ ⚗️ Run static analysis using **PHPStan**:
83
+ ```bash
84
+ composer test:types
85
+ ```
24
86
 
25
- ## Contributing
87
+ Run unit tests using **PEST**
88
+ ```bash
89
+ composer test:unit
90
+ ```
26
91
 
27
- See the [Contributing](CONTRIBUTING.md) guide for details.
92
+ 🚀 Run the entire test suite:
93
+ ```bash
94
+ composer test
95
+ ```
28
96
 
97
+ ### Frontend
29
98
 
30
- ## License
99
+ 🧹 Keep a modern codebase with **ESLint**:
100
+ ```bash
101
+ pnpm lint
102
+ ```
31
103
 
32
- This project is licensed under the [MIT License](LICENSE.md).
104
+ Run unit tests using **Ember/QUnit**
105
+ ```bash
106
+ pnpm test
107
+ pnpm test:ember
108
+ pnpm test:ember-compatibility
109
+ ```
110
+
111
+ 🚀 Start the Ember Addon/Engine
112
+ ```bash
113
+ pnpm start
114
+ ```
115
+
116
+ 🔨 Build the Ember Addon/Engine
117
+ ```bash
118
+ pnpm build
119
+ ```
120
+
121
+ ## Contributing
122
+ See the Contributing Guide for details on how to contribute to this project.
123
+
124
+ ## License
125
+ This project is licensed under the MIT License.
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/adapters/addon-category';
1
+ export { default } from '@fleetbase/storefront/adapters/addon-category';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/adapters/gateway';
1
+ export { default } from '@fleetbase/storefront/adapters/gateway';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/adapters/network';
1
+ export { default } from '@fleetbase/storefront/adapters/network';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/adapters/notification-channel';
1
+ export { default } from '@fleetbase/storefront/adapters/notification-channel';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/adapters/product-addon-category';
1
+ export { default } from '@fleetbase/storefront/adapters/product-addon-category';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/adapters/product-addon';
1
+ export { default } from '@fleetbase/storefront/adapters/product-addon';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/adapters/product-hour';
1
+ export { default } from '@fleetbase/storefront/adapters/product-hour';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/adapters/product-store-location';
1
+ export { default } from '@fleetbase/storefront/adapters/product-store-location';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/adapters/product-variant-option';
1
+ export { default } from '@fleetbase/storefront/adapters/product-variant-option';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/adapters/product-variant';
1
+ export { default } from '@fleetbase/storefront/adapters/product-variant';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/adapters/product';
1
+ export { default } from '@fleetbase/storefront/adapters/product';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/adapters/store-hour';
1
+ export { default } from '@fleetbase/storefront/adapters/store-hour';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/adapters/store-location';
1
+ export { default } from '@fleetbase/storefront/adapters/store-location';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/adapters/store';
1
+ export { default } from '@fleetbase/storefront/adapters/store';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/adapters/storefront';
1
+ export { default } from '@fleetbase/storefront/adapters/storefront';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/file-record';
1
+ export { default } from '@fleetbase/storefront/components/file-record';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/add-store-hours';
1
+ export { default } from '@fleetbase/storefront/components/modals/add-store-hours';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/add-store-to-category';
1
+ export { default } from '@fleetbase/storefront/components/modals/add-store-to-category';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/add-stores-to-network';
1
+ export { default } from '@fleetbase/storefront/components/modals/add-stores-to-network';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/assign-driver';
1
+ export { default } from '@fleetbase/storefront/components/modals/assign-driver';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/create-first-store';
1
+ export { default } from '@fleetbase/storefront/components/modals/create-first-store';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/create-gateway';
1
+ export { default } from '@fleetbase/storefront/components/modals/create-gateway';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/create-network-category';
1
+ export { default } from '@fleetbase/storefront/components/modals/create-network-category';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/create-network';
1
+ export { default } from '@fleetbase/storefront/components/modals/create-network';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/create-new-variant';
1
+ export { default } from '@fleetbase/storefront/components/modals/create-new-variant';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/create-notification-channel';
1
+ export { default } from '@fleetbase/storefront/components/modals/create-notification-channel';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/create-product-category';
1
+ export { default } from '@fleetbase/storefront/components/modals/create-product-category';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/create-store';
1
+ export { default } from '@fleetbase/storefront/components/modals/create-store';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/edit-network';
1
+ export { default } from '@fleetbase/storefront/components/modals/edit-network';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/import-products';
1
+ export { default } from '@fleetbase/storefront/components/modals/import-products';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/incoming-order';
1
+ export { default } from '@fleetbase/storefront/components/modals/incoming-order';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/manage-addons';
1
+ export { default } from '@fleetbase/storefront/components/modals/manage-addons';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/order-ready-assign-driver';
1
+ export { default } from '@fleetbase/storefront/components/modals/order-ready-assign-driver';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/select-addon-category';
1
+ export { default } from '@fleetbase/storefront/components/modals/select-addon-category';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/share-network';
1
+ export { default } from '@fleetbase/storefront/components/modals/share-network';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/store-details';
1
+ export { default } from '@fleetbase/storefront/components/modals/store-details';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/store-form';
1
+ export { default } from '@fleetbase/storefront/components/modals/store-form';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/modals/store-location-form';
1
+ export { default } from '@fleetbase/storefront/components/modals/store-location-form';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/network-category-picker';
1
+ export { default } from '@fleetbase/storefront/components/network-category-picker';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/order-card';
1
+ export { default } from '@fleetbase/storefront/components/order-card';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/schedule-manager';
1
+ export { default } from '@fleetbase/storefront/components/schedule-manager';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/settings-container';
1
+ export { default } from '@fleetbase/storefront/components/settings-container';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/store-selector';
1
+ export { default } from '@fleetbase/storefront/components/store-selector';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/widget/customers';
1
+ export { default } from '@fleetbase/storefront/components/widget/customers';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/widget/orders';
1
+ export { default } from '@fleetbase/storefront/components/widget/orders';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/components/widget/storefront-metrics';
1
+ export { default } from '@fleetbase/storefront/components/widget/storefront-metrics';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/application';
1
+ export { default } from '@fleetbase/storefront/controllers/application';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/customers/index';
1
+ export { default } from '@fleetbase/storefront/controllers/customers/index';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/home';
1
+ export { default } from '@fleetbase/storefront/controllers/home';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/networks/index/network/customers';
1
+ export { default } from '@fleetbase/storefront/controllers/networks/index/network/customers';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/networks/index/network/index';
1
+ export { default } from '@fleetbase/storefront/controllers/networks/index/network/index';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/networks/index/network/orders';
1
+ export { default } from '@fleetbase/storefront/controllers/networks/index/network/orders';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/networks/index/network/stores';
1
+ export { default } from '@fleetbase/storefront/controllers/networks/index/network/stores';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/networks/index/network';
1
+ export { default } from '@fleetbase/storefront/controllers/networks/index/network';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/networks/index';
1
+ export { default } from '@fleetbase/storefront/controllers/networks/index';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/orders/index';
1
+ export { default } from '@fleetbase/storefront/controllers/orders/index';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/products/index/category/edit';
1
+ export { default } from '@fleetbase/storefront/controllers/products/index/category/edit';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/products/index/category/new';
1
+ export { default } from '@fleetbase/storefront/controllers/products/index/category/new';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/products/index/category';
1
+ export { default } from '@fleetbase/storefront/controllers/products/index/category';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/products/index/index/edit';
1
+ export { default } from '@fleetbase/storefront/controllers/products/index/index/edit';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/products/index/index';
1
+ export { default } from '@fleetbase/storefront/controllers/products/index/index';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/products/index';
1
+ export { default } from '@fleetbase/storefront/controllers/products/index';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/settings/api';
1
+ export { default } from '@fleetbase/storefront/controllers/settings/api';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/settings/gateways';
1
+ export { default } from '@fleetbase/storefront/controllers/settings/gateways';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/settings/index';
1
+ export { default } from '@fleetbase/storefront/controllers/settings/index';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/settings/locations';
1
+ export { default } from '@fleetbase/storefront/controllers/settings/locations';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/controllers/settings/notifications';
1
+ export { default } from '@fleetbase/storefront/controllers/settings/notifications';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/helpers/get-tip-amount';
1
+ export { default } from '@fleetbase/storefront/helpers/get-tip-amount';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/models/addon-category';
1
+ export { default } from '@fleetbase/storefront/models/addon-category';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/models/gateway';
1
+ export { default } from '@fleetbase/storefront/models/gateway';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/models/network';
1
+ export { default } from '@fleetbase/storefront/models/network';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/models/notification-channel';
1
+ export { default } from '@fleetbase/storefront/models/notification-channel';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/models/product-addon-category';
1
+ export { default } from '@fleetbase/storefront/models/product-addon-category';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/models/product-addon';
1
+ export { default } from '@fleetbase/storefront/models/product-addon';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/models/product-hour';
1
+ export { default } from '@fleetbase/storefront/models/product-hour';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/models/product-store-location';
1
+ export { default } from '@fleetbase/storefront/models/product-store-location';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/models/product-variant-option';
1
+ export { default } from '@fleetbase/storefront/models/product-variant-option';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/models/product-variant';
1
+ export { default } from '@fleetbase/storefront/models/product-variant';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/models/product';
1
+ export { default } from '@fleetbase/storefront/models/product';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/models/store-hour';
1
+ export { default } from '@fleetbase/storefront/models/store-hour';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/models/store-location';
1
+ export { default } from '@fleetbase/storefront/models/store-location';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/models/store';
1
+ export { default } from '@fleetbase/storefront/models/store';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/routes/application';
1
+ export { default } from '@fleetbase/storefront/routes/application';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/routes/customers/index/edit';
1
+ export { default } from '@fleetbase/storefront/routes/customers/index/edit';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/routes/customers/index';
1
+ export { default } from '@fleetbase/storefront/routes/customers/index';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/routes/home';
1
+ export { default } from '@fleetbase/storefront/routes/home';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/routes/networks/index/network/customers';
1
+ export { default } from '@fleetbase/storefront/routes/networks/index/network/customers';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/routes/networks/index/network/index';
1
+ export { default } from '@fleetbase/storefront/routes/networks/index/network/index';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/routes/networks/index/network/orders';
1
+ export { default } from '@fleetbase/storefront/routes/networks/index/network/orders';
@@ -1 +1 @@
1
- export { default } from '@fleetbase/storefront-engine/routes/networks/index/network/stores';
1
+ export { default } from '@fleetbase/storefront/routes/networks/index/network/stores';