This repository has been archived by the owner on Jun 28, 2022. It is now read-only.
forked from scandipwa/scandipwa
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
78fa213
commit b86f3a2
Showing
290 changed files
with
52,303 additions
and
662 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
runtime-packages/test | ||
runtime-packages/test-* | ||
runtime-packages/test/**/* | ||
|
||
build-packages/xmldom |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to make participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, sex characteristics, gender identity and expression, | ||
level of experience, education, socio-economic status, nationality, personal | ||
appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
- Using welcoming and inclusive language | ||
- Being respectful of differing viewpoints and experiences | ||
- Gracefully accepting constructive criticism | ||
- Focusing on what is best for the community | ||
- Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
- The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
- Trolling, insulting/derogatory comments, and personal or political attacks | ||
- Public or private harassment | ||
- Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
- Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all project spaces, and it also applies when | ||
an individual is representing the project or its community in public spaces. | ||
Examples of representing a project or community include using an official | ||
project e-mail address, posting via an official social media account, or acting | ||
as an appointed representative at an online or offline event. Representation of | ||
a project may be further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at <[email protected]>. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see | ||
https://www.contributor-covenant.org/faq |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# Contributing to Create ScandiPWA App | ||
|
||
Loving Create ScandiPWA App and want to get involved? Thanks! There are plenty of ways you can help. | ||
|
||
Please take a moment to review this document in order to make the contribution process straightforward and effective for everyone involved. | ||
|
||
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features. | ||
|
||
## Core Ideas | ||
|
||
The Create ScandiPWA App ideas build on-top-of what Create React App has defined. Read [their core ideas](https://github.com/facebook/create-react-app/blob/master/CONTRIBUTING.md#core-ideas) first. | ||
|
||
### Extensibilty and hierarchy | ||
|
||
Everything we build must be extensible. Opening up the build configuration for plugins was not obligatory, thus we specifically looked for the technology with plugin support - [Craco](https://github.com/gsoft-inc/craco). The hierarchy means we must always keep in mind our source-code priority: from extension, to parent-themes, to the user theme. | ||
|
||
## Submitting a Pull Request | ||
|
||
Good pull requests, such as patches, improvements, and new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits. | ||
|
||
Please ask first if somebody else is already working on this or the core developers think your feature is in-scope for Create ScandiPWA App. Generally always have a related issue with discussions for whatever you are including. | ||
|
||
Please also provide a test plan, i.e. specify how you verified that your addition works. | ||
|
||
## Folder Structure | ||
|
||
``` | ||
└── 📁 build-packages | ||
├── 📁 babel-plugin-middleware-decorator | ||
├── 📁 craco | ||
├── 📁 create-scandipwa-app | ||
├── 📁 csa-generator-blank | ||
├── 📁 csa-generator-extension | ||
├── 📁 csa-generator-theme | ||
├── 📁 eslint-config | ||
├── 📁 eslint-plugin-scandipwa-guidelines | ||
├── 📁 scandipwa-cli | ||
├── 📁 scandipwa-dev-utils | ||
├── 📁 scandipwa-development-toolkit-csa | ||
├── 📁 scandipwa-extensibility | ||
├── 📁 scandipwa-scripts | ||
├── 📁 webpack-extension-import-loader | ||
├── 📁 webpack-fallback-plugin | ||
└── 📁 webpack-i18n-plugin | ||
``` | ||
|
||
## Setting up a local copy | ||
|
||
Setting Up a Local Copy | ||
1. Clone the repo with `git clone https://github.com/scandipwa/create-scandipwa-app` | ||
2. Run `yarn` in the root `create-scandipwa-app` folder. | ||
|
||
You may now create a test project using `create-scandipwa-app`, for that, type in: `yarn csa`. This will create a ScandiPWA project in `runtime-packages/csa` and print you futher instructions. | ||
|
||
## Publishing | ||
|
||
Use `lerna publish --exact` command. | ||
|
||
For canary publishing, use `lerna publish --canary --exact --preid next --dist-tag=next minor` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
![Create ScandiPWA App](https://user-images.githubusercontent.com/29531824/104035489-ddbfff80-51da-11eb-8efc-88adb4283cf5.png) | ||
|
||
A zero-configuration tool-chain which allows for front-end application theming, extension and translation. | ||
|
||
- [Creating an App](https://scandipwa.gitbook.io/create-scandipwa-app/getting-started/getting-started#creating-an-app) – How to create a new app. | ||
- [User Guide](https://scandipwa.gitbook.io/create-scandipwa-app/) – How to develop apps bootstrapped with Create ScandiPWA App. | ||
|
||
Create ScandiPWA App works on MacOS, Windows, and Linux. If something doesn’t work, please [file an issue](https://github.com/scandipwa/create-scandipwa-app/issues/new). | ||
|
||
## Most important features | ||
|
||
### Application plugins :dna: | ||
|
||
Create [modular](https://scandipwa.gitbook.io/create-scandipwa-app/extensions/extensions) front-end application with unlimited extensibility using the [application plugins](https://scandipwa.gitbook.io/create-scandipwa-app/extensions/application-plugins) feature. | ||
|
||
### Theme overrides :nail_care: | ||
|
||
Create [reusable presentations](https://scandipwa.gitbook.io/create-scandipwa-app/themes/extensions-and-themes) of your frontend with inheritance-based [theming mechansim](https://scandipwa.gitbook.io/create-scandipwa-app/themes/parent-themes). | ||
|
||
### Build configuration plugins :clamp: | ||
|
||
Break boundaries with [pluggable build configurations](https://scandipwa.gitbook.io/create-scandipwa-app/extensions/build-configuration-plugins). Package your build-configuration into a module and share across projects. | ||
|
||
But that's not it! Create ScandiPWA App also allows for [virtual modules](https://app.gitbook.com/@scandipwa/s/create-scandipwa-app/extensions/virtual-modules), [file provision](https://app.gitbook.com/@scandipwa/s/create-scandipwa-app/extensions/file-provision), [translations](https://scandipwa.gitbook.io/create-scandipwa-app/building-your-app/internationalization) and more! | ||
|
||
## Creating an App | ||
|
||
**You’ll need to have Node >= 10.13 on your local development machine** (but it’s not required on the server). You can use [n](https://www.npmjs.com/package/n) (macOS, Linux) or [nvm-windows](https://github.com/coreybutler/nvm-windows#node-version-manager-nvm-for-windows) to switch Node versions between different projects. | ||
|
||
To create a new blank app, you may choose one of the following methods: | ||
|
||
#### NPX | ||
|
||
```bash | ||
npx create-scandipwa-app my-app | ||
``` | ||
|
||
[npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher | ||
|
||
#### NPM | ||
|
||
```bash | ||
npm init scandipwa-app my-app | ||
``` | ||
|
||
`npm init <initializer>` is available in npm 6+ | ||
|
||
#### Yarn | ||
|
||
```bash | ||
yarn create scandipwa-app my-app | ||
``` | ||
|
||
`yarn create` is available in Yarn 0.25+ | ||
|
||
> **Note**: To create an application independent from [Magento 2](https://magento.com/), add `--template blank` option to creation command. | ||
## Contribution | ||
|
||
We'd love to have your helping hand on `create-scandipwa-app`! See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information on what we're looking for and how to get started. | ||
|
||
Thanks to these **awesome** :heart: people for contribution! | ||
|
||
<a href="https://github.com/scandipwa/create-scandipwa-app/graphs/contributors"> | ||
<img src="https://contributors-img.web.app/image?repo=scandipwa/create-scandipwa-app" /> | ||
</a> | ||
|
||
## License | ||
|
||
Create ScandiPWA App is open source software licensed as [OSL-3.0](./LICENSE). | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# create-scandipwa-app | ||
|
||
This package contains global command for [Create Scandipwa App](https://github.com/scandipwa/create-scandipwa-app). | ||
|
||
Package is currently under development. Docs too. | ||
|
||
**Try at your own risk!** |
Oops, something went wrong.