Move the development docs to docs.saleor.io (#344)
* Move the development docs to docs.saleor.io * Delete docs directory
This commit is contained in:
parent
aa8a96a0ba
commit
fdf9423a17
2 changed files with 1 additions and 73 deletions
44
README.md
44
README.md
|
@ -49,46 +49,4 @@ In the `apps` folder, you will find the following applications:
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
### Setup
|
You can find the documentation for saleor/apps on [docs.saleor.io](https://docs.saleor.io/docs/3.x/developer/app-store/development).
|
||||||
|
|
||||||
Make sure you have installed `pnpm`:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install -g pnpm
|
|
||||||
```
|
|
||||||
|
|
||||||
Install all dependencies:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pnpm install
|
|
||||||
```
|
|
||||||
|
|
||||||
Start the apps` dev servers:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pnpm dev
|
|
||||||
```
|
|
||||||
|
|
||||||
> The apps' ports will be displayed in the terminal output.
|
|
||||||
>
|
|
||||||
> You can find the required env vars for each app in `apps/NAME/.env.example` file.
|
|
||||||
|
|
||||||
To start an individual app, run:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pnpm dev --filter=saleor-app-X
|
|
||||||
```
|
|
||||||
|
|
||||||
where X is the app's name (matching saleor/X).
|
|
||||||
|
|
||||||
### Build
|
|
||||||
|
|
||||||
To build all apps, run:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pnpm build
|
|
||||||
```
|
|
||||||
|
|
||||||
### Documentation
|
|
||||||
|
|
||||||
- [Forking](/docs/forking.md)
|
|
||||||
|
|
|
@ -1,30 +0,0 @@
|
||||||
# Forking
|
|
||||||
|
|
||||||
Saleor apps come out of the box in Saleor Cloud plans, but all apps are open source and can be used
|
|
||||||
under the [BSD-3 license](../LICENSE).
|
|
||||||
|
|
||||||
When forking, you are most likely interested in an individual app. This monorepo, however, contains all of the Saleor apps.
|
|
||||||
|
|
||||||
Luckily, you can still fork and be able to track and merge the original source code with two strategies:
|
|
||||||
|
|
||||||
## 1. Delete unused apps
|
|
||||||
|
|
||||||
The repository contains apps and packages which are imported by apps. Apps never import other apps,
|
|
||||||
so you can safely delete them.
|
|
||||||
|
|
||||||
When you remove all the apps except the one you need, Turborepo will continue to work the same way.
|
|
||||||
|
|
||||||
Additionally, you can run scripts per individual apps with `turbo run SCRIPT --filter=saleor-app-NAME`.
|
|
||||||
|
|
||||||
We recommend not removing anything else to avoid unnecessary conflicts.
|
|
||||||
|
|
||||||
If you want to update the repository, you can still merge or rebase it with the original source code.
|
|
||||||
You may face conflicts for apps you don't have anymore, but you can safely delete them again during conflict resolution.
|
|
||||||
|
|
||||||
## 2. Keep everything
|
|
||||||
|
|
||||||
To avoid conflicts to a minimum, you can leave other apps and just ignore them. These tips can help you with a single app experience:
|
|
||||||
|
|
||||||
- Mark other app folders as "excluded" in your IDE to avoid indexing these files.
|
|
||||||
- Run your scripts with Turborepo filters, e.g. `turbo run SCRIPT --filter=saleor-app-NAME`.
|
|
||||||
- Use `pnpm` to avoid duplicated packages. `pnpm` installs packages once and links them, which causes minimal performance overhead of node_modules.
|
|
Loading…
Reference in a new issue