Files
spacedrive/docs/developers/prerequisites/environment-setup.md
Utku 85b429336d Mobile Actions & File Info Modal (#573)
* better drawer

* fix build?

* style changes

* fix subfolder navigation

* bigger icons and drawer style tweaks

* Disable Menu animation

* more subfolder navigation & title stuff

* move tag dialogs to modal

* cleanup

* Fix text input sizing

* Improve modal component

* Hide modal close button & fix position

* update packages

* style create tag / update tag modals.

* move dialogs to modal & new modal component

* move IsPath and isObject to client + small fixes

* fix FileModal

* move kind to client

* move everything to components + cleanup

* move format bytes, info pills, work on fileinfo and actions modal, update packages, rename xcode build step

* Update Device.tsx

remove placeholder data

* small fixes

* actions modal header and some styling

* fav button

* actions item, divider and container components

* file actions

* file info modal

* remove bg-green from Inspector

* Add more info to fileinfo modal

* Delete unused Device component

* fix merge stuff

* linting + changed how we export tw + rename tw.style to twStyle
2023-02-20 05:24:59 +00:00

2.0 KiB

index
index
1

Environment Setup

To get started contributing to Spacedrive, follow this guide carefully.

This project uses Cargo and pnpm.

Installation

  1. Clone repo

    git clone https://github.com/spacedriveapp/spacedrive && cd spacedrive
    
  2. Run setup script

    For Linux or MacOS users run:

    ./.github/scripts/setup-system.sh
    

    This will install FFmpeg and any other required dependencies for Spacedrive to build.

    ...or for Windows users run using PowerShell:

    .\.github\scripts\setup-system.ps1
    

    This will install pnpm, LLVM, FFmpeg and any other required dependencies for Spacedrive to build. Ensure you run it like documented above as it expects it is executed from the root of the repository.

  3. Install dependencies

    pnpm i
    
  4. Run codegen & build required dependencies

    pnpm prep
    

Running apps

  • Desktop: pnpm desktop dev
  • Landing: pnpm landing dev
  • Server: DATA_DIR=/path/to/library cargo run -p sdcore
  • Webapp: pnpm web dev

::: slot note When changing branches, make sure to run pnpm prep command right after. This ensures all the codegen is up to date. :::

Mobile app

To run mobile app

  1. Install Android Studio for Android and Xcode for IOS development
  2. ./.github/scripts/setup-system.sh mobile The should setup most of the dependencies for the mobile app to build.
  3. You must also ensure you have NDK 24.0.8215888 and CMake in Android Studio
  4. pnpm mobile android - runs on Android Emulator
  5. pnpm mobile ios - runs on iOS Emulator

Troubleshooting

If you are having issues ensure you are using the following versions of Rust and Node:

  • Rust version: 1.67.0
  • Node version: 17