chore(docs)

This commit is contained in:
Laegel
2020-02-27 22:01:06 +01:00
committed by GitHub
parent 213d3955eb
commit 6fd40c03e4

View File

@@ -1,14 +1,32 @@
# Tauri x Realworld apps
This project is an experiment to demonstrate how easy you can bundle an existing frontend app with Tauri, whichever the framework you're using, without having to change a single line from the codebase.
The main script (build.js) simply consists in a pipeline that will clone, install dependencies, build the application, initialize Tauri then bundle the application.
## Setup
1. Take a look at the Wiki to setup Tauri: https://github.com/tauri-apps/tauri/wiki
2. Have Git, Node and NPM installed
3. Clone and install this project dependencies, either with NPM or Yarn:
```bash
git clone git@github.com:tauri-apps/realworld.git
cd realworld
yarn install
# OR
npm install
```
## Usage
Install dependencies with `yarn`
`node build {{app.repo}}`
This will apply the pipeline on a single application from apps.yaml. Copy/paste a `repo` property from the wanted application and let it build.
Fully build and bundle all apps (AKA "download all NPM"; not working properly yet): `node build`
`node build`
This will apply the pipeline on _every_ application from apps.yaml. Unless you have some spare time, enough disk space, a nice CPU and unlimited bandwidth, you should avoid to do it (and ensure the pipeline at least works for a single project in a first time).
Build and bundle a specific app: `node build {{app.repo}}`*
## Details about apps.yaml
*take a look at apps.yaml to find all app repos.
Commented apps have not been successfully bundled, either because of the build or the bundle phase failing.
A detail about what's wrong is displayed above the app title.
Commented apps have not been successfully bundled (yet), either because of the build or the bundle phase failing.
A detail about what's wrong is displayed above the app title.