Skip to content

Commit

Permalink
Alokai refactor (#1504)
Browse files Browse the repository at this point in the history
* alokai rebranding

* alokai rebranding

* Delete docs/README.md

---------

Co-authored-by: krystian wlodarski <[email protected]>
Co-authored-by: Wojciech Sikora <[email protected]>
  • Loading branch information
3 people authored Mar 19, 2024
1 parent 02f8485 commit 54dadef
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 37 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<div align="center">
<img src="https://user-images.githubusercontent.com/1626923/137092657-fb398d20-b592-4661-a1f9-4135db0b61d5.png" height="80px"/>  <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/5/55/Magento_Logo.svg/2560px-Magento_Logo.svg.png" height="80px"/>
<img src="https://res.cloudinary.com/vue-storefront/image/upload/v1710754524/Logo_green_2x_z4vmhz.png" height="80px"/>
<br>
<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/5/55/Magento_Logo.svg/2560px-Magento_Logo.svg.png" height="80px"/>
</div>


Expand All @@ -12,25 +14,25 @@



**This repository contains integration for Magento 2 and Vue Storefront Middleware.**
**This repository contains integration for Magento 2 and Alokai Middleware.**
This integration is framework-agnostic and may be consumed in the framework of your choice.

## Magento 2 integration for Vue Storefront
## Magento 2 integration for Alokai

This project is a Magento 2 integration for Vue Storefront.
This project is a Magento 2 integration for Alokai.

### Check out [the docs](https://docs.vuestorefront.io/sdk-magento2/)

# Quick start

Your Vue Storefront application has two parts:
Your Alokai application has two parts:

1. **Server Middleware** - an Express.js application that can connect to your various third-party services (like Magento).


2. **Front-end application** - any application using JavaScript or TypeScript that can connect to the server middleware. Popular choices include [Nuxt](https://nuxt.com/) and [Next.js](https://nextjs.org/).

In this section, we will explain in a step-by-step guide how to use Magento 2 integration in each part of your Vue Storefront application.
In this section, we will explain in a step-by-step guide how to use Magento 2 integration in each part of your Alokai application.


## Prerequisites
Expand Down Expand Up @@ -271,12 +273,12 @@ Find more information about the module [GraphQl Custom Config](https://github.co
## Resources
- [Magento 2 integration Documentation](https://docs.vuestorefront.io/sdk-magento2/)
- [Vue Storefront Documentation](https://docs.vuestorefront.io/v2/)
- [Alokai Documentation](https://docs.vuestorefront.io/v2/)
- [Community Chat](http://discord.vuestorefront.io)
## Support
If you have any questions about this integration we will be happy to answer them on `magento2-vsf2` channel on [our Discord](http://discord.vuestorefront.io).
If you have any questions about this integration we will be happy to answer them on `magento2-alokai` channel on [our Discord](http://discord.vuestorefront.io).
## Contributors ✨
Expand Down
22 changes: 0 additions & 22 deletions docs/README.md

This file was deleted.

13 changes: 8 additions & 5 deletions packages/api-client/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
<div align="center">
<img src="https://user-images.githubusercontent.com/1626923/137092657-fb398d20-b592-4661-a1f9-4135db0b61d5.png" height="80px"/>  <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/5/55/Magento_Logo.svg/2560px-Magento_Logo.svg.png" height="80px"/>
<img src="https://res.cloudinary.com/vue-storefront/image/upload/v1710754524/Logo_green_2x_z4vmhz.png" height="80px"/>
<br>
<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/5/55/Magento_Logo.svg/2560px-Magento_Logo.svg.png" height="80px"/>
</div>

## Vue Storefront 2 integration with Magento

### @vue-storefront/magento-api
## Alokai integration with Magento

### @alokai/magento-api

This is only the **api-client** package, you need to install the other dependencies also.

This project is a Magento 2 integration for Vue Storefront 2.
This project is a Magento 2 integration for Alokai.
This integration developed by superheroes from [Caravel](https://github.com/caravelx) ❤️
<div align="center">
<img src="https://user-images.githubusercontent.com/1626923/127100067-98eda368-94e3-47dd-b824-842d38dc8550.png" height="80px"/>
Expand Down Expand Up @@ -81,7 +84,7 @@ Find more information about the module [GraphQl Custom Config](https://github.co
## Resources
- [Vue Storefront Documentation](https://docs.vuestorefront.io/v2/)
- [Alokai Documentation](https://docs.vuestorefront.io/v2/)
- [Magento 2 integration Documentation (WIP)](https://docs.vuestorefront.io/magento)
- [Community Chat](http://discord.vuestorefront.io)
Expand Down
4 changes: 2 additions & 2 deletions packages/load-tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ Please run tests locally before running on the cloud or comitting them to make s

#### Accessing K6 web dashboard
Before you ask the K6 cloud to run the tests for you, please make sure that:
1. You logged in at [app.k6.io](https://app.k6.io) with your VSF Google domain account
2. You were invited to the VSF K6 organization (K6 won't automatically add you to it - even though you're using your domain account) - ask Miłosz if you don't have access
1. You logged in at [app.k6.io](https://app.k6.io) with your Alokai Google domain account
2. You were invited to the Alokai K6 organization (K6 won't automatically add you to it - even though you're using your domain account) - ask Miłosz if you don't have access
3. In the sidebar in the top right, select the "Magento" project.
That way you'll be able to access the test results.

Expand Down

0 comments on commit 54dadef

Please sign in to comment.