Skip to content

Commit eeee4ff

Browse files
DominikWolosDominikWolos
committed
Add Readme
1 parent ea642e5 commit eeee4ff

1 file changed

Lines changed: 125 additions & 122 deletions

File tree

‎README.md‎

Lines changed: 125 additions & 122 deletions
Original file line numberDiff line numberDiff line change
@@ -1,122 +1,125 @@
1-
<p align="center">
2-
<a href="https://sylius.com" target="_blank">
3-
<img src="https://demo.sylius.com/assets/shop/img/logo.png" />
4-
</a>
5-
</p>
6-
7-
<h1 align="center">Plugin Skeleton</h1>
8-
9-
<p align="center">Skeleton for starting Sylius plugins.</p>
10-
11-
## Documentation
12-
13-
For a comprehensive guide on Sylius Plugins development please go to Sylius documentation,
14-
there you will find the <a href="https://docs.sylius.com/en/latest/plugin-development-guide/index.html">Plugin Development Guide</a>, that is full of examples.
15-
16-
## Quickstart Installation
17-
18-
### Traditional
19-
20-
1. Run `composer create-project sylius/plugin-skeleton ProjectName`.
21-
22-
2. From the plugin skeleton root directory, run the following commands:
23-
24-
```bash
25-
$ (cd tests/Application && yarn install)
26-
$ (cd tests/Application && yarn build)
27-
$ (cd tests/Application && APP_ENV=test bin/console assets:install public)
28-
29-
$ (cd tests/Application && APP_ENV=test bin/console doctrine:database:create)
30-
$ (cd tests/Application && APP_ENV=test bin/console doctrine:schema:create)
31-
```
32-
33-
To be able to set up a plugin's database, remember to configure you database credentials in `tests/Application/.env` and `tests/Application/.env.test`.
34-
35-
### Docker
36-
37-
1. Execute `docker compose up -d`
38-
39-
2. Initialize plugin `docker compose exec app make init`
40-
41-
3. See your browser `open localhost`
42-
43-
## Usage
44-
45-
### Running plugin tests
46-
47-
- PHPUnit
48-
49-
```bash
50-
vendor/bin/phpunit
51-
```
52-
53-
- PHPSpec
54-
55-
```bash
56-
vendor/bin/phpspec run
57-
```
58-
59-
- Behat (non-JS scenarios)
60-
61-
```bash
62-
vendor/bin/behat --strict --tags="~@javascript"
63-
```
64-
65-
- Behat (JS scenarios)
66-
67-
1. [Install Symfony CLI command](https://symfony.com/download).
68-
69-
2. Start Headless Chrome:
70-
71-
```bash
72-
google-chrome-stable --enable-automation --disable-background-networking --no-default-browser-check --no-first-run --disable-popup-blocking --disable-default-apps --allow-insecure-localhost --disable-translate --disable-extensions --no-sandbox --enable-features=Metal --headless --remote-debugging-port=9222 --window-size=2880,1800 --proxy-server='direct://' --proxy-bypass-list='*' http://127.0.0.1
73-
```
74-
75-
3. Install SSL certificates (only once needed) and run test application's webserver on `127.0.0.1:8080`:
76-
77-
```bash
78-
symfony server:ca:install
79-
APP_ENV=test symfony server:start --port=8080 --dir=tests/Application/public --daemon
80-
```
81-
82-
4. Run Behat:
83-
84-
```bash
85-
vendor/bin/behat --strict --tags="@javascript"
86-
```
87-
88-
- Static Analysis
89-
90-
- Psalm
91-
92-
```bash
93-
vendor/bin/psalm
94-
```
95-
96-
- PHPStan
97-
98-
```bash
99-
vendor/bin/phpstan analyse -c phpstan.neon -l max src/
100-
```
101-
102-
- Coding Standard
103-
104-
```bash
105-
vendor/bin/ecs check
106-
```
107-
108-
### Opening Sylius with your plugin
109-
110-
- Using `test` environment:
111-
112-
```bash
113-
(cd tests/Application && APP_ENV=test bin/console sylius:fixtures:load)
114-
(cd tests/Application && APP_ENV=test bin/console server:run -d public)
115-
```
116-
117-
- Using `dev` environment:
118-
119-
```bash
120-
(cd tests/Application && APP_ENV=dev bin/console sylius:fixtures:load)
121-
(cd tests/Application && APP_ENV=dev bin/console server:run -d public)
122-
```
1+
2+
# BitBag SyliusUserComPlugin
3+
4+
----
5+
6+
We want to impact many unique eCommerce projects and build our brand recognition worldwide, so we are heavily involved in creating open-source solutions, especially for Sylius. We have already created over **35 extensions, which have been downloaded almost 2 million times.**
7+
8+
You can find more information about our eCommerce services and technologies on our website: https://bitbag.io/. We have also created a unique service dedicated to creating plugins: https://bitbag.io/services/sylius-plugin-development.
9+
10+
Do you like our work? Would you like to join us? Check out the **“Career” tab:** https://bitbag.io/pl/kariera.
11+
12+
# About Us
13+
14+
---
15+
16+
BitBag is a software house that implements tailor-made eCommerce platforms with the entire infrastructure—from creating eCommerce platforms to implementing PIM and CMS systems to developing custom eCommerce applications, specialist B2B solutions, and migrations from other platforms.
17+
18+
We actively participate in Sylius's development. We have already completed **over 150 projects**, cooperating with clients worldwide, including smaller enterprises and large international companies. We have completed projects for such important brands as **Mytheresa, Foodspring, Planeta Huerto (Carrefour Group), Albeco, Mollie, and ArtNight.**
19+
20+
We have a 70-person team of experts: business analysts and consultants, eCommerce developers, project managers, and QA testers.
21+
22+
**Our services:**
23+
* B2B and B2C eCommerce platform implementations
24+
* Multi-vendor marketplace platform implementations
25+
* eCommerce migrations
26+
* Sylius plugin development
27+
* Sylius consulting
28+
* Project maintenance and long-term support
29+
* PIM and CMS implementations
30+
31+
**Some numbers from BitBag regarding Sylius:**
32+
* 70 experts on board
33+
* +150 projects delivered on top of Sylius
34+
* 30 countries of BitBag’s customers
35+
* 7 years in the Sylius ecosystem
36+
* +35 plugins created for Sylius
37+
38+
---
39+
[![](https://bitbag.io/wp-content/uploads/2024/09/badges-sylius.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_productbandle)
40+
41+
---
42+
43+
44+
45+
## Table of Content
46+
47+
***
48+
49+
* [Overview](#overview)
50+
* [Installation](#installation)
51+
* [Testing](#testing)
52+
* [Functionalities](#functionalities)
53+
* [Demo](#demo)
54+
* [License](#license)
55+
* [Contact](#contact)
56+
* [Community](#community)
57+
58+
# Overview
59+
60+
----
61+
The **SyliusUserComPlugin** allows you to integrate your Sylius store with the User.com platform. User.com is a platform that allows you to automate your marketing, sales, and support processes. With this plugin, you can synchronize your Sylius store with User.com and use the data collected in your store to create personalized marketing campaigns, automate sales processes, and provide better customer support.
62+
63+
64+
# Installation
65+
----
66+
67+
68+
# Testing
69+
----
70+
71+
```bash
72+
$ composer install
73+
$ cd tests/Application
74+
$ yarn install
75+
$ yarn build
76+
$ bin/console assets:install public -e test
77+
$ bin/console doctrine:schema:create -e test
78+
$ bin/console server:run 127.0.0.1:8080 -d public -e test
79+
$ open http://localhost:8080
80+
$ vendor/bin/behat
81+
```
82+
83+
# Functionalities
84+
85+
All main functionalities of the plugin are described **[here.](https://github.com/BitBagCommerce/SyliusUserComPlugin/blob/master/doc/functionalities.md)**
86+
87+
---
88+
89+
If you need some help with Sylius development, don't be hesitated to contact us directly. You can fill the form on [this site](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_productbundle) or send us an e-mail at hello@bitbag.io!
90+
91+
---
92+
# Demo
93+
---
94+
We created a demo app with some useful use-cases of plugins! Visit http://demo.sylius.com/ to take a look at it.
95+
96+
**If you need an overview of Sylius' capabilities, schedule a consultation with our expert.**
97+
98+
[![](https://bitbag.io/wp-content/uploads/2020/10/button_free_consulatation-1.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_productbundle)
99+
100+
101+
# Additional resources for developers
102+
---
103+
To learn more about our contribution workflow and more, we encourage you to use the following resources:
104+
* [Sylius Documentation](https://docs.sylius.com/en/latest/)
105+
* [Sylius Contribution Guide](https://docs.sylius.com/en/latest/contributing/)
106+
* [Sylius Online Course](https://sylius.com/online-course/)
107+
* [Sylius Product Bundle Plugin Blog](https://bitbag.io/blog/product-bundling-sylius)
108+
109+
# License
110+
---
111+
112+
This plugin's source code is completely free and released under the terms of the MIT license.
113+
114+
[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen.)
115+
116+
# Contact
117+
---
118+
This open-source plugin was developed to help the Sylius community. If you have any additional questions, would like help with installing or configuring the plugin, or need any assistance with your Sylius project - let us know! **Contact us** or send us an **e-mail to hello@bitbag.io** with your question(s).
119+
120+
# Community
121+
----
122+
123+
For online communication, we invite you to chat with us & other users on **[Sylius Slack](https://sylius-devs.slack.com/).**
124+
125+
[![](https://bitbag.io/wp-content/uploads/2024/09/badges-partners.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_productbundle)

0 commit comments

Comments
 (0)