Prerequisites

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

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 23.1.7779620 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.68.2
• Node version: 18

Seeding data on startup

You can add a file called sd_init.json in the same folder where you start Spacedrive and it can automatically seed data on startup.

{
	"resetOnStartup": false,
	"libraries": [
		{
			"id": "26697dc0-ef06-4b39-ad72-ffe5d5205b61",
			"name": "Oscar's Library",
			"password": "password",
			"resetLocationsOnStartup": true,
			"locations": [
				{
					"path": "/Users/oscar/Pictures/assets"
				}
			]
		}
	]
}