Knowledge base

.env.example

@@ -0,0 +1,2 @@
+# Use the testnet in development
+# ALEPH_API_URL=https://api.twentysix.testnet.network

.github/workflows/build.yaml

@@ -1,28 +1,17 @@
 name: Build
 
-on:
-  push:
-    branches: ["main"]
-  pull_request:
-    branches: ["main"]
+on: push
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js 18
-        uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18
-      - name: Cache dependencies
-        uses: actions/cache@v3
-        with:
-          path: ~/.cache/npm
-          key: ${{ runner.OS }}-npm-${{ hashFiles('**/npm.lock') }}
-          restore-keys: |
-            ${{ runner.OS }}-npm-
+          node-version: 20
+          cache: 'npm'
       - name: Install dependencies
         run: npm install
       - name: Build

.github/workflows/fmt.yaml

@@ -1,28 +1,17 @@
 name: FormatCheck
 
-on:
-  push:
-    branches: ["main"]
-  pull_request:
-    branches: ["main"]
+on: push
 
 jobs:
   format-check:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js 18
-        uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18
-      - name: Cache dependencies
-        uses: actions/cache@v3
-        with:
-          path: ~/.cache/npm
-          key: ${{ runner.OS }}-npm-${{ hashFiles('**/npm.lock') }}
-          restore-keys: |
-            ${{ runner.OS }}-npm-
+          node-version: 20
+          cache: 'npm'
       - name: Install dependencies
         run: npm install
       - name: Lint

.github/workflows/lint.yaml

@@ -1,28 +1,17 @@
 name: Lint
 
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
+on: push
 
 jobs:
   lint:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js 18
-        uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18
-      - name: Cache dependencies
-        uses: actions/cache@v3
-        with:
-          path: ~/.cache/yarn
-          key: ${{ runner.OS }}-yarn-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.OS }}-yarn-
+          node-version: 20
+          cache: 'npm'
       - name: Install dependencies
         run: npm install
       - name: Lint

README.md

@@ -4,31 +4,29 @@ A UI for decentralized AI
 
 ## Install the dependencies
 
-```bash
-npm i
+```sh
+npm install
 ```
 
-### Start the app in development mode (hot-code reloading, error reporting, etc.)
-
-```bash
-quasar dev
-```
+> Don't forget to also fill environment variables in a `.env` file. You can use [`.env.example`](.env.example) as an
+> inspiration.
 
-### Lint the files
+### Start the app in development mode (hot-code reloading, error reporting, etc.)
 
-```bash
-npm run lint
+```sh
+npm run dev
 ```
 
-### Format the files
+### Format and lint the files
 
-```bash
+```sh
 npm run format
+npm run lint
 ```
 
 ### Build the app for production
 
-```bash
+```sh
 npm run build
 ```