Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #36

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,14 @@
4. [For developers](#for-developers)

## About seQura

### Description

seQura is the flexible payment platform that will help your business improve conversion and recurrence.
seQura is the flexible payment platform that will help your business improve conversion an

![](https://holocron.so/uploads/13f3371f-image.png)

d recurrence.
The easiest, safest, and quickest way for your customers to pay on installments.

+6.000 e-commerce and +1.5 million delight shoppers already use seQura. Are you still thinking about it?
Expand All @@ -32,7 +37,6 @@ Your customers in good hands:
* Local support teams to deliver the best shopper experience
* Secure data, we don’t share your data with anyone or use your information to sell our own or third-party products


Obsessed with conversion and recurrence

* We adapt to your business, solutions for every sector, and buyer profile
Expand All @@ -59,6 +63,7 @@ If you are not a seQura merchant yet, you can sign up [here](https://sqra.es/sig
## For developers

### How to try the module

The repository includes a docker-compose file to easily test the module. You can start the environment with the following command:

```bash
Expand All @@ -70,6 +75,7 @@ This will start a Magento 2 instance with the seQura module installed. You can a
Once installed you could start/stop the magento instance with `docker compose up` and `docker compose down` commands.

### Customizing the environment

You could create you own .env file to customize the environment. You can copy the .env.example file and modify the values as needed.

In order to use magento sample data you MUST set your credentials for https://repo.magento.com/ in you .env file at
Expand All @@ -79,16 +85,19 @@ COMPOSER_AUTH='{"http-basic":{"repo.magento.com":{"username":"<public-key>","pas
```

Otherwise you will get a warning message:

> "warning": "You haven't provided your Magento authentication keys. For instructions, visit https://devdocs.magento.com/guides/v2.3/install-gde/prereq/connect-auth.html"

and the installation will fail.

#### Other examples

* You can customize the Magento version by setting the `MAGENTO_VERSION` environment variable.
* You can customize the sequra/magento module version by setting the `SQ_M2_CORE_VERSION` environment variable. Leave it as local to use the local version of the module.
* You can customize the host and ports by setting the `MAGENTO_HOST` and `MAGENTO_HTTP_PORT` environment variable.

### Loading sample data

You can load sample data with the following command:

```bash
Expand All @@ -97,34 +106,39 @@ You can load sample data with the following command:

or setting the `MAGENTO_SAMPLEDATA` environment variable to `yes` when before running the ./setup.sh script.


> After installing sample data you may get 404 errors for http://${MAGENTO_HOST}/%7B%7BMEDIA_URL%7D%7Dstyles.css.
> To fix this issue go to Content -> Design -> Configuration -> Edit your theme -> HTML Head -> Scripts and Style Sheets and change the line with `{{MEDIA_URL}}styles.css` to `media/styles.css`

### Other helper scripts

You can run commands in the Magento container with the following command:

```bash
./bin/magento <command>
```

To run magento commands in the container.

```bash
./bin/composer <command>
```

To run composer commands in the container.

```bash
./bin/mysql
```

To open mysql terminal in the container.

```bash
./bin/shell
```

To open a bash shell commands in the container.

```bash
./bin/xdebug
```
To toggle xdebug it will be enabled by default.

To toggle xdebug it will be enabled by default.
Loading