mirror of
https://github.com/storytold/artcraft.git
synced 2026-10-19 02:20:17 -05:00
Brandon Thomas
0004726a36
This is a fresh start for the `artcraft` repo. The old monorepo, which included our web API gateway, job services, SRE tools, various frontends, and more has moved to `artcraft-services` You can find the full git history here: https://github.com/storytold/artcraft-services This change was motivated by the fact that the entire git history was hundreds of gigabytes in size, which is unwieldy for anyone not in the core team that doesn't care about support services outside of the core artcraft app. We wanted to keep this repo in its well-known place since we already have users and activity here. Please update your remotes to either `artcraft-services` or make a fresh clone of this repo. History can be found at the artcraft-services repo.
41 lines
1.4 KiB
Markdown
41 lines
1.4 KiB
Markdown
Dev Setup
|
|
=========
|
|
|
|
# ArtCraft
|
|
|
|
ArtCraft is a Rust / Tauri app.
|
|
|
|
To set up the ArtCraft development environment, install the following:
|
|
|
|
1. [Install Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html).
|
|
2. [Install npm](https://nodejs.org/en/download) or [nvm](https://github.com/nvm-sh/nvm). (Node version `v24.13.0` works at time of writing.)
|
|
3. [Install nx](https://nx.dev/docs/getting-started/installation). (Nx version `v22.4.5` works at time of writing.)
|
|
4. [Install Tauri CLI](https://v2.tauri.app/reference/cli/). (Version `tauri-cli 2.10.0` works at time of writing.)
|
|
|
|
An easy way to get started with running the app in development is to run the two commands (in separate terminals):
|
|
|
|
**Mac and Linux Development**
|
|
|
|
```bash
|
|
# Run the frontend dev server
|
|
./script/artcraft/unix_frontend_dev.sh
|
|
|
|
# Run the Tauri Rust application
|
|
./script/artcraft/unix_rust_dev.sh
|
|
```
|
|
|
|
**Windows Development**
|
|
|
|
```powershell
|
|
# Run the frontend dev server
|
|
.\script\artcraft\windows_frontend_dev.ps1
|
|
|
|
# Run the Tauri Rust application
|
|
.\script\artcraft\windows_rust_dev.ps1
|
|
```
|
|
|
|
Backend services and website builds live in the separate `artcraft-services` repository.
|
|
This repository retains the desktop task database in
|
|
`_database/sql/artcraft_migrations/` and its SQLite query cache in `.sqlx/`.
|
|
Use `SQLX_OFFLINE=true cargo check -p artcraft` to check Rust without a database server.
|