collective
Browse / github.com/storytold/artcraft / patch
docs: update desktop frontend setup instructions
docs: update desktop frontend setup instructions ## What / Why / How The app-level README still describes the former hosted web application: it asks contributors to start a `/proxy` service that is absent from the current public repository, documents Netlify deployments, and points to the former backend documentation. The repository now contains the Tauri desktop app, with the supported setup documented in `_docs/dev_setup.md` and the frontend workspace instructions in `frontend/README.md`. This change updates `frontend/apps/artcraft/README.md` to: - Identify the app as the ArtCraft desktop frontend. - Point to the existing desktop setup
- Status
- open
- Score
- 0.00
- Adopters
- 0 other operators
- Author
- shuaiyafei (imported from pull request #2502, open)
- Base
7a2935cf9e3922e90e4ed5f3556b1cb107013148- Size
- +24 −106 in 1 file
- Review
- pending
- Shared
- 2026-10-28
- Id
982b23577117a290ef1e34ed
How it went
No other operator has reported using it yet.
Diff
raw · frontend/apps/artcraft/README.md
@@ -1,4 +1,27 @@-# Storyteller GGF+# ArtCraft desktop frontend++This directory contains the React and Vite frontend packaged by the Tauri+desktop app. Backend services and website builds live in the separate+`artcraft-services` repository.++## Local development++Start with the [desktop development setup](../../../_docs/dev_setup.md) for+Rust, Tauri, Node.js, and platform prerequisites.++On macOS or Linux, run the combined launcher from the repository root:++```bash+./script/artcraft/unix_dev.sh+```++The launcher starts the frontend and Rust/Tauri together and selects an+available loopback port. The setup guide covers Windows commands, port+configuration, hot reload, and shutdown.++For frontend-only development, follow the [frontend workspace guide](../../README.md).+Install dependencies from `frontend/` and use the workspace-local Nx commands+documented there. A standalone frontend server does not start the Tauri app. ## Coding Rules and Styles @@ -23,108 +46,3 @@ if (condition) { No use of any type. If you can use chat gpt to create the interface. ```--## Branches--- `main` - The main branch is the production source of truth.-- Changes to main will automatically build, but will not auto-deploy to production. You'll have to promote changes to production using the Netlify control panel.-- Merge your code to main frequently. If you have to have a long-lived set of changes, ask yourself whether it might be better to feature flag your code off and- land it to main rather than fight rebasing against the whole team.--- `studio-staging` - The staging auto-deploy branch.-- You do not ever need to interact with this branch. Changes to `main` will automatically be pushed to `studio-staging` and auto-deployed to- https://studio-staging.studio.storyteller.ai . You can test changes that have landed in `main` here before promoting them to production.--- `studio-testing` - The testing branch.--Anyone can push their changes to this branch for testing in a production-like environment. Since it is built and hosted on https://studio-testing.studio.storyteller.ai ,-you won't face CORS issues, same-site cookie issues, or have to use a local development proxy. (This doesn't obviate the need for a development-proxy for fast development iteration, but is a fantastic way to test your changes in a "production-like" environment.)--Force push to this branch by using `git push -f origin studio-testing`--## API Docs--Server API docs live here: https://storyteller-docs.netlify.app/--## Local Testing & Development--### Apple Silicon package installation issues--Installation of some dependencies via npm may fail on M-series macs (like node-canvas) and may require additional setup including python3 and some brew dependencies:--```-brew install pkg-config cairo pango libpng jpeg giflib librsvg pixman python-setuptools-```--### Set up `.env` and the Proxy Server--Copy & paste the env settings from `.env-local-proxy` to `.env`, (if the file `.env` do not exist, simply create one at the root of this project's folder beside the other env settings files).--The settings from `.env-local-proxy` directs all requests to `localhost:3000`, this will relieve us from having to deal with CORS between various services.--Then, start the proxy server in the folder `/proxy`. Before running the proxy for the first time, run:--```-npm i-```--To start the proxy run:--```-npm run dev-```--If the proxy fails, make sure your node version is 18.18. If you need to change the node version-run `npm rebuild` once before re-running `npm run dev`--### Run the Code Locally--To setup and run this project's code locally:--```-npm install-npm run dev-```--## PostHog--PostHog is installed and working. To create a feature flag go to https://us.posthog.com/project/75284/feature_flags-Add the feature flag for all users.--To check the feature flag in the app use code similar to this--```ts-import { usePosthogFeatureFlag } from "~/hooks/usePosthogFeatureflag";-import { FeatureFlags } from "~/enums";--const Component = () => {- const flag = usePosthogFeatureFlag(FeaturesFlags.FLAG_NAME);- // if flag is true, the feature shoud be executed & showed;- // if flag is false, the feature should be disabled & hid;- // for example- return(- <>- {flag && <ComponentThatDependsOnTheFlag />}- </>- );-};-```--## Other Documentation--Here is the Swagger documentation for the backend endpoints--- https://storyteller-docs.netlify.app/--This project uses Remix for routing and Tailwind for styling:--- [Remix Docs](https://remix.run/docs)-- [Tailwind Docs](https://tailwindcss.com/docs)--On Netlify, we use functions:--- [Netlify Functions Overview](https://docs.netlify.com/functions/overview)