Jelajahi Sumber

Add shortcuts

Manav Rathi 1 tahun lalu
induk
melakukan
aabdab1a13
3 mengubah file dengan 10 tambahan dan 2 penghapusan
  1. 3 1
      README.md
  2. 5 1
      docs/dev.md
  3. 2 0
      package.json

+ 3 - 1
README.md

@@ -40,11 +40,13 @@ The app is deployed to [web.ente.io](https://web.ente.io)
 1. Clone this repository with `git clone https://github.com/ente-io/photos-web.git`
 1. Clone this repository with `git clone https://github.com/ente-io/photos-web.git`
 2. Pull in all submodules with `git submodule update --init --recursive`
 2. Pull in all submodules with `git submodule update --init --recursive`
 3. Install dependencies with `yarn install`
 3. Install dependencies with `yarn install`
-4. Finally, run the development server with `yarn dev:photos`
+4. Finally, run the development server with `yarn dev`
 
 
 Open [http://localhost:3000](http://localhost:3000) to see the live app (with
 Open [http://localhost:3000](http://localhost:3000) to see the live app (with
 hot reload).
 hot reload).
 
 
+`yarn dev` runs the photos app. To run the auth app, do `yarn dev:auth`.
+
 <br/>
 <br/>
 
 
 ## 🙋 Help
 ## 🙋 Help

+ 5 - 1
docs/dev.md

@@ -15,10 +15,14 @@ full list of such aliases. The two common patterns are `dev:<app-name>` for
 running a local development server, and `build:<app-name>` for creating a
 running a local development server, and `build:<app-name>` for creating a
 production build.
 production build.
 
 
+> Tip: `yarn dev` is a shorcut for `yarn dev:photos`
+
 Note that yarn does not automatically update `node_modules` if you switch to a
 Note that yarn does not automatically update `node_modules` if you switch to a
 branch that has added or modified dependencies. So if you encounter unexpected
 branch that has added or modified dependencies. So if you encounter unexpected
 errors on switching branches, make sure that your `node_modules` is up to date
 errors on switching branches, make sure that your `node_modules` is up to date
-by running `yarn install` first (tip: `yarn` is a shortcut for `yarn install`).
+by running `yarn install` first.
+
+> `yarn` is a shortcut for `yarn install`
 
 
 To add a local package as a dependency, use `<package-name>@*`. The "*" here
 To add a local package as a dependency, use `<package-name>@*`. The "*" here
 denotes any version.
 denotes any version.

+ 2 - 0
package.json

@@ -7,10 +7,12 @@
         "packages/*"
         "packages/*"
     ],
     ],
     "scripts": {
     "scripts": {
+        "build": "yarn build:photos",
         "build:accounts": "yarn workspace accounts next build",
         "build:accounts": "yarn workspace accounts next build",
         "build:auth": "yarn workspace auth next build",
         "build:auth": "yarn workspace auth next build",
         "build:cast": "yarn workspace cast next build",
         "build:cast": "yarn workspace cast next build",
         "build:photos": "yarn workspace photos next build",
         "build:photos": "yarn workspace photos next build",
+        "dev": "yarn dev:photos",
         "dev:accounts": "yarn workspace accounts next dev",
         "dev:accounts": "yarn workspace accounts next dev",
         "dev:auth": "yarn workspace auth next dev",
         "dev:auth": "yarn workspace auth next dev",
         "dev:cast": "yarn workspace cast next dev",
         "dev:cast": "yarn workspace cast next dev",