Skip to content

Commit

Permalink
Merge pull request #1 from SteponasK/Update-Readme.md
Browse files Browse the repository at this point in the history
Update readme.md
  • Loading branch information
SteponasK committed Mar 25, 2024
2 parents 9b06196 + 7ed0089 commit 628af02
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 5 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 Invertus
Copyright (c) 2020 SteponasK

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
Binary file added README-Pictures/hook.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added README-Pictures/pdf-label.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added README-Pictures/print-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 31 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,41 @@
# PrestaShop Academy ERP Integration module
# Carrier Module for PrestaShop

PrestaShop Academy ERP Integration module used for version >= 1.7.6.5
Carrier Module made for PrestaShop to easily print PDF Labels of a given Shipment.

## Features
- DisplayAdminOrderMain Hook
- Create Custom Carrier
- Save Customer's information to the Database
- Generate PDF Label of a given customer
- Automatically Install & Uninstall Carrier on module's Installation and Uninstallation
- Github CI/CD Pipelines (Automatically create .zip Artifact to use in Production)

## Usage
* Information is prefilled already, change it according to your needs
![](./README-Pictures/hook.png)
* After information is saved, the "Print Label" button appears
![](./README-Pictures/print-button.png)
* Press it & PDF file should open in a new tab automatically!
![](./README-Pictures/pdf-label.png)
## Getting Started

clone repository and add it to modules folder on a PrestaShop system
- Clone repository
```
git clone https://github.com/SteponasK/Prestashop-Shipping.git
```
- Add it to modules folder on a PrestaShop system
- Install module in: Modules -> Module Manager -> Others

### Prerequisites
* composer
* Downloaded ERP Repository: [GitHub link](https://github.com/SteponasK/Prestashop-Shipping-ERP)
* Running Symfony Server
* Composer
* PHP >= 8.2
* Prestashop >= 1.7.6.5


# Authors
* SteponasK - Initial Work

## License

Expand Down

0 comments on commit 628af02

Please sign in to comment.