From 6fd40c03e4f747761dbaf9d3655785a6099d3c63 Mon Sep 17 00:00:00 2001 From: Laegel Date: Thu, 27 Feb 2020 22:01:06 +0100 Subject: [PATCH] chore(docs) --- README.md | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 35aa1d3..ed85d86 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +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.