diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e41d00585..c4c758044 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -111,13 +111,10 @@ To run the mobile app: - Make sure you have [NDK 26.1.10909125 and CMake](https://developer.android.com/studio/projects/install-ndk#default-version) installed in Android Studio. - Run the following commands: - `pnpm mobile android` (runs on Android Emulator) - - In order to have locations working on Android, you must run the following command once the application has been installed for the first time. Otherwise, locations will not work. + - In order to have locations working on Android, you must run the following command once the application has been installed for the first time (if the app fails to request the `MANAGE_EXTERNAL_STORAGE` permission). Otherwise, locations will not work. - `adb shell appops set --uid com.spacedrive.app MANAGE_EXTERNAL_STORAGE allow` - Run the following commands to access the logs from `sd-core`. - - `adb shell` - - Then `run-as com.spacedrive.app` to access the app's directory on device. - - Run `cd files/logs` and then select the logs with the timestamp of when you ran the app. Ex: `sd.log.2023-11-28`. - - You can view the logs using `tail -f [log-name]`. Ex: `tail -f sd.log.2023-11-28`. + - `adb logcat | grep -i com.spacedrive.app` - `pnpm mobile ios` (runs on iOS Emulator) - `xcrun simctl launch --console booted com.spacedrive.app` allows you to view the console output of the iOS app from `tracing`. However, the application must be built in `debug` mode for this. - `pnpm mobile start` (runs the metro bundler only) diff --git a/apps/landing/package.json b/apps/landing/package.json index 60b4066cc..23fedacdf 100644 --- a/apps/landing/package.json +++ b/apps/landing/package.json @@ -27,7 +27,7 @@ "image-size": "^1.0.2", "katex": "^0.16.9", "markdown-to-jsx": "^7.3.2", - "next": "13.5.6", + "next": "14.2.5", "next-contentlayer": "^0.3.4", "next-plausible": "^3.11.3", "react": "18.2.0", diff --git a/apps/landing/src/app/Downloads/DockerDialog.tsx b/apps/landing/src/app/Downloads/DockerDialog.tsx index c886d428b..f7ecf3822 100644 --- a/apps/landing/src/app/Downloads/DockerDialog.tsx +++ b/apps/landing/src/app/Downloads/DockerDialog.tsx @@ -20,7 +20,7 @@ export function DockerDialog({ - +

Docker

{/* Link */} @@ -31,7 +31,8 @@ export function DockerDialog({ + */} +
{children}
); diff --git a/docs/developers/prerequisites/environment-setup.mdx b/docs/developers/prerequisites/environment-setup.mdx index 86f80ecef..68da1901c 100644 --- a/docs/developers/prerequisites/environment-setup.mdx +++ b/docs/developers/prerequisites/environment-setup.mdx @@ -58,20 +58,31 @@ This project uses [Cargo](https://doc.rust-lang.org/cargo/getting-started/instal To run mobile app 1. Install [Android Studio](https://developer.android.com/studio) for Android and [Xcode](https://apps.apple.com/au/app/xcode/id497799835) for IOS development -2. `./scripts/setup.sh mobile` - _The should setup most of the dependencies for the mobile app to build._ +2. _This should setup most of the dependencies for the mobile app to build._ + ```shell + ./scripts/setup.sh mobile + ``` 3. You must also ensure you have [NDK 26.1.10909125 and CMake](https://developer.android.com/studio/projects/install-ndk#default-version) in Android Studio -4. `pnpm mobile android` (runs on Android Emulator) - - In order to have locations working on Android, you must run the following command once the application has been installed for the first time. Otherwise, locations will not work. - - `adb shell appops set --uid com.spacedrive.app MANAGE_EXTERNAL_STORAGE allow` +4. To run on Android (emulator or device), run: + ```shell + pnpm mobile android + ``` - Run the following commands to access the logs from `sd-core`. - - `adb shell` - - Then `run-as com.spacedrive.app` to access the app's directory on device. - - Run `cd files/logs` and then select the logs with the timestamp of when you ran the app. Ex: `sd.log.2023-11-28`. - - You can view the logs using `cat [log-name]`. Ex: `cat sd.log.2023-11-28`. -5. `pnpm mobile ios` (runs on iOS Emulator) - - `xcrun simctl launch --console booted com.spacedrive.app` allows you to view the console output of the iOS app from `tracing`. However, the application must be built in `debug` mode for this. -6. `pnpm mobile start` (runs the metro bundler only) + ```shell + adb logcat | grep -i com.spacedrive.app + ``` +5. To run on iOS (runs on iOS Emulator), run: + ```shell + pnpm mobile ios + ``` + - The following command allows you to view the console output of the iOS app from `tracing`. However, the application must be built in `debug` mode for this. + ```shell + xcrun simctl launch --console booted com.spacedrive.app + ``` +6. To run the UI only (runs the metro bundler only): + ```shell + pnpm mobile start + ``` ### Troubleshooting diff --git a/docs/developers/prerequisites/welcome.mdx b/docs/developers/prerequisites/welcome.mdx index fd59a5c14..9230f2dff 100644 --- a/docs/developers/prerequisites/welcome.mdx +++ b/docs/developers/prerequisites/welcome.mdx @@ -1,5 +1,5 @@ --- -index: 0 +index: -1 --- # Spacedrive Developers diff --git a/docs/product/guides/cli.mdx b/docs/product/guides/cli.mdx index 5aaf4ca83..ab65d38f3 100644 --- a/docs/product/guides/cli.mdx +++ b/docs/product/guides/cli.mdx @@ -19,8 +19,14 @@ Spacedrive is available as a command-line interface (CLI) tool. The CLI is a pow ```bash # Launch Spacedrive spacedrive -d +``` + +```bash # View help menu spacedrive --help +``` + +```bash # View version and build information spacedrive --info ``` @@ -32,12 +38,24 @@ At least one identifier such as `--name`, `--path` or `--id` is required for eac ```bash # List all Locations spacedrive location list +``` + +```bash # Add a Location spacedrive location add /path/to/folder --name "Location Name" +``` + +```bash # Remove a Location by name spacedrive location remove --name "Location Name" +``` + +```bash # Remove a Location by path spacedrive location remove --path /local/path/to/location +``` + +```bash # Rescan a Location spacedrive location rescan --id 4 spacedrive location rescan --id 4 --full # Full rescan diff --git a/docs/product/guides/importing-photos.mdx b/docs/product/guides/importing-photos.mdx index e97573b8b..f1cdd1a03 100644 --- a/docs/product/guides/importing-photos.mdx +++ b/docs/product/guides/importing-photos.mdx @@ -18,6 +18,6 @@ An importer tool will be shipped in an upcoming release, which will not only imp In an upcoming release we will ship a dedicated interface for importing media from removable storage, with the option to exclude already imported media. It will default to your preferences for photo storage and place the new media in a designated folder. -## Google and Apple Photosß +## Google and Apple Photos We are working on this, but it is not available yet. Please check our [roadmap](/roadmap) for updates. diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 975cf1468..18d1f6257 100644 Binary files a/pnpm-lock.yaml and b/pnpm-lock.yaml differ