Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/spryker-community/multi-factor-authentication

Hackathon team "Authentication Alliance" built this POC for a MFA tool for the Spryker backend
https://github.com/spryker-community/multi-factor-authentication

hackathon hackathon-may-2024 multifactor-authentication spryker

Last synced: about 1 month ago
JSON representation

Hackathon team "Authentication Alliance" built this POC for a MFA tool for the Spryker backend

Host: GitHub
URL: https://github.com/spryker-community/multi-factor-authentication
Owner: spryker-community
License: other
Created: 2024-05-13T12:07:56.000Z (9 months ago)
Default Branch: main
Last Pushed: 2024-05-14T14:36:28.000Z (9 months ago)
Last Synced: 2024-11-06T02:32:56.829Z (3 months ago)
Topics: hackathon, hackathon-may-2024, multifactor-authentication, spryker
Language: PHP
Homepage:
Size: 244 MB
Stars: 0
Watchers: 4
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Spryker B2B Demo Shop
[![Build Status](https://github.com/spryker-shop/b2b-demo-shop/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/spryker-shop/b2b-demo-shop/actions?query=branch:master)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/spryker-shop/b2b-demo-shop/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/spryker-shop/b2b-demo-shop/?branch=master)
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%208.1-8892BF.svg)](https://php.net/)

## Description

Spryker B2B Demo Shop is a collection of Spryker B2B-specific features. It suits most projects as a starting point of development and can be used to explore Spryker.

## B2B Demo Shop quick start

This section describes how to get started with the B2B Demo Shop quickly.

For detailed installation instructions, see [Installing Spryker with Docker](https://docs.spryker.com/docs/scos/dev/setup/installing-spryker-with-docker/installing-spryker-with-docker.html) or [Installing with Development Virtual Machine](https://docs.spryker.com/docs/scos/dev/developer-getting-started-guide.html#installing-spryker-with-development-virtual-machine).

### Prerequisites

For full installation prerequisites, see one of the following:
* [Installing Docker prerequisites on MacOS](https://docs.spryker.com/docs/scos/dev/setup/installing-spryker-with-docker/docker-installation-prerequisites/installing-docker-prerequisites-on-macos.html)
* [Installing Docker prerequisites on Linux](https://docs.spryker.com/docs/scos/dev/setup/installing-spryker-with-docker/docker-installation-prerequisites/installing-docker-prerequisites-on-linux.html)
* [Installing Docker prerequisites on Windows](https://docs.spryker.com/docs/scos/dev/setup/installing-spryker-with-docker/docker-installation-prerequisites/installing-docker-prerequisites-on-windows-with-wsl2.html)

Recommended system requirements for MacOS:

|Macbook type |vCPU |RAM|
|---|---|---|
|15'| 4 |6GB|
|13'| 2 |4GB|

### Installing the B2B Demo Shop

To set up the B2B Demo Shop and its environment, do the following:

1. Create a project folder and navigate into it:
```bash
mkdir spryker-b2b && cd spryker-b2b
```

2. Clone the B2B Demo Shop:
```bash
git clone https://github.com/spryker-shop/b2b-demo-shop.git ./
```

3. Clone the Docker SDK:
```bash
git clone [email protected]:spryker/docker-sdk.git docker
```

2. Set up a desired environment:
* [Setting up a development environment](#setting-up-a-development-environment)
* [Setting up a production-like environment](#setting-up-a-production-like-environment)

#### Setting up a development environment

1. Bootstrap the docker setup:

```bash
docker/sdk boot deploy.dev.yml
```

2. If the command you've run in the previous step returned instructions, follow them.

3. Build and start the instance:
```bash
docker/sdk up
```

4. Switch to your branch, re-build the application with assets and demo data from the new branch:

```bash
git checkout {your_branch}
docker/sdk boot -s deploy.dev.yml
docker/sdk up --build --assets --data
```

> Depending on your requirements, you can select any combination of the following `up` command attributes. To fetch all the changes from the branch you switch to, we recommend running the command with all of them:
> - `--build` - update composer, generate transfer objects, etc.
> - `--assets` - build assets
> - `--data` - get new demo data

You've set up your Spryker B2B Demo Shop and can access your applications.

### Setting up a production-like environment

1. Bootstrap the docker setup:

```bash
docker/sdk boot -s
```

2. If the command you've run in the previous step returned instructions, follow them.

3. Build and start the instance:
```bash
docker/sdk up
```

4. Switch to your branch in one of the following ways:

* Switch to your brunch, re-build the application with assets and demo data from the new branch:

```bash
git checkout {your_branch}
docker/sdk boot -s
docker/sdk up --assets --data
```

* Light git checkout:

```bash
git checkout {your_branch}
docker/sdk boot -s

docker/sdk up
```

5. Reload all the data:

```bash
docker/sdk clean-data && docker/sdk up && docker/sdk console q:w:s -v -s
```

You've set up your Spryker B2B Demo Shop and can access your applications.

## Troubleshooting installation of the B2B Demo Shop

This section describes the most common issues related to the installation of the B2B Demo Shop.

For a complete troubleshooting, see [Troubleshooting Spryker in Docker issues](https://docs.spryker.com/docs/troubleshooting-spryker-in-docker-issues).

**when**

You get unexpected application behavior or errors.

**then**

1. Check the state of the directory:
```bash
git status
```

2. If there are untracked files (returned in red), and they are not necessary, remove them.

3. Restart file synchronization and rebuild the codebase:
```bash
docker/sdk trouble
docker/sdk boot -s deploy.dev.yml
docker/sdk up --build --assets
```

**when**
You do not see the expected demo data on the Storefront.

**then**

1. Open the [queue broker](http://queue.spryker.local) and wait until all the queues are empty.

2. If the queues are empty, and the issue persists, reload the demo data:
```bash
docker/sdk trouble
docker/sdk boot -s deploy.dev.yml
docker/sdk up --build --assets --data
```

## Installation of B2B Demo Shop with Docker

For detailed installation instructions of Spryker with Docker, see [Installing Spryker with Docker](https://docs.spryker.com/docs/scos/dev/setup/installing-spryker-with-docker/installing-spryker-with-docker.html).

## Glue API reference

See Glue API reference at [REST API reference](https://docs.spryker.com/docs/scos/dev/glue-api-guides/202108.0/rest-api-reference.html)

## Contributing to the repository

For contribution guidelines, see [Code contribution guide](https://docs.spryker.com/docs/scos/dev/code-contribution-guide.html#opening-pull-requests)