From 01ffa385e380ee212f43cafa8f8a8dc22c2834bd Mon Sep 17 00:00:00 2001 From: Arnab Chakraborty <11457760+Rocky43007@users.noreply.github.com> Date: Mon, 22 Jul 2024 22:23:50 +0300 Subject: [PATCH] Updates to Landing (#2632) * Updates to Landing Site - Docker Modal Sizing fixed for mobile - Matching button looks for copying across the site - Move to Next.js `v14.2.5` - Change the banner to `Alpha 0.4 is out` with a link to the release changelog. - Updates to docs for easier copy-pasting commands. * Update mobile docs in contributing * Reorganize to have welcome first Have welcome first in the list in the developers section of docs * Formatting --- CONTRIBUTING.md | 7 +--- apps/landing/package.json | 2 +- .../src/app/Downloads/DockerDialog.tsx | 5 ++- apps/landing/src/app/layout.tsx | 8 +++- apps/landing/src/app/page.tsx | 6 ++- apps/landing/src/components/mdx/Pre.tsx | 26 ++++++++++--- .../prerequisites/environment-setup.mdx | 35 ++++++++++++------ docs/developers/prerequisites/welcome.mdx | 2 +- docs/product/guides/cli.mdx | 18 +++++++++ docs/product/guides/importing-photos.mdx | 2 +- pnpm-lock.yaml | Bin 1036068 -> 1036145 bytes 11 files changed, 81 insertions(+), 30 deletions(-) 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 975cf14683c82b0184292ae0869f1656012556f1..18d1f6257b2664a9053d5a39c602aba9d5891553 100644 GIT binary patch delta 2628 zcma)8TZ|i58J6wMZanL?6Vhyx-OXmxMor3uof&(^9;XS3$M^AN?D1`8fCyj4_Sj>O z$M*O#CFFvlRYeJ^tm+^tLPCqw^3p^RvUrJtRH;v>K}d)P#3o2QP*DUgNIW!PZ?fA^ zir9xUn)ChV|GxR>KmR%ZJ2%e#{l>Z52O%TzGWed!wmkaN#p>N3LYmP)jMRnYyYRxt zHUmDoGqX5@;p=wbxn^D*xmTB;Ki`t`!+u+;RJ%x5>~zm#>$rU#19x7vo*BJ$ ztLvltmbuXftKr>yfZN}N7Qm4o8O(R@AH}{6(4X1PgUyHYbKfCvjL92@(;HK+(WA|i zUqf^uSZ}A9PCK71^R-}t)M9AM*+wZ}+BwLz>a|j~P}H5y1f5N_`W)vN#wB)G9C$Qe znTiB+R9m1pR*N8fR<6e@gHW*F@SHt+5rV*_Lkr8`z)Qxrx79L;Th9(?IO3MudMYSO z7=j>LZOE3DCL%ONQGk1RtJ{(i3X_3@5uw>2b2ZW*&1JAe!xaq4U7n@ta)XPdGinU+ zsY$mx0Pg(4xC+p(oAv|d&&DNi>4fp%j$)4sF$r(K>=WH;)TgPg494&=dq2a&ktFUP zI2FC$i40nHCneKPjw^&@k;%vP z74YCw!@^Y24DMB-{h!IoRf_C~VYx=Cn12w+k#ZrYbv<~@F68xOycf%9exE87HJUEE zNGa2dmJ$iANhLV4?Zv~Dv{McbkbH@Pz5TZAcE|L1{)y~%pbLO887*M#%SIb`T!kz< z+VPf;a>p~Qy^B^kou>QAR8Ygh9)=$lI%Sc9qk~qk!?oFP!Ifm%d_yYHx}#Iod9oOD z!fgikC^bziqj4nR&vO{rlHAPy(mu2;nU$=FehPr+h4 zosmkB(vZpW5}{_23Q}PQJ;V{m6d~ZPs4cM*cLoxo8jQK@LQjO7te6Fl+Ix-w^yDPJ zKmO3L73=|XL+i-rr^Pniz!_&U+Lv5xo|lroBI`?K5T%2oZ9+kv1ws>Dbf-?xl@dz@ zgDp~axLCnob<>?_Dn=#)DDUf3ib^LXhH4eLqDpoGZlHMh$(Gtm@V2fQY)a59_zP_O z>`!CCR?wcU7CJ2k&htu)NhXq#T12`*M^tZgN>m7qR-3+*gKl?y1ADTeb0SJP8!17M z;too6g_#&P=wVH{Q`40c2D=-&FuL>mm1)TPz&X?8!F)7{`~E58()N$egez6IAP@RI zudkyyaR(XTSvu5cC+!J>k77PW zK-D}GsTagRPK<#!j+tKok1v=Y@Ye<7@>J0VZhyrH?Z|fhNtYruRSfagQbD(tN{j7c z-qFK70$d8@VVu{TQZ*kWGbOTAQlrUAAXsendAWl*LIg*66TXB%m-xX@jA@dyp)t`C zz9V}GtOrb%jmzuC@#S^XYllaF+&sZYg8ZNtX1HQeWIP3b9WO{oDI4`i+&bA2P>rG- zVVNjk?P}R8r&>i09hO-JjWp7Am9-a}N#C&1k5aIm5QZ^5?5!Zh1~NUI-oz{`;N#=Q zqvH=kCeuFfo1d6YWJ2z~QwpaVEFABJa84U~1q#=FaSZL2-E5%iln^%^^4Icg)uZ%F zo;(dJ5~m`Lx>%C*xK|Fvx`lL-sG*AL%O>iA&l4tr;hyp6Mu9g?#>`~w85j83^!o-J zv>xw$IgOUdJX@x+QMl34%T$doC$(sXJ*z%w+Vmh61L9V+Ubc1q_m zc$bZ3QN}Z1Nr4t}i9pk-Ra0KVnMrqmYMeQ;2P4-p7kKcAX%V1r?Og%iq>PK;hIwvb z^jr17-n9#p>j<0NSMQkT-kcyS;8#84!3{SwH+DmNZ~b%Q^%?W{^%*E%v`h+Zoj7rN z?bV$l{kbX>-LnOQ=#*P!GkN-xw);K&&AaGM}ReBJP%HN$+B!9Hf~*q z#<#A|uPNYG3_3b~`04yV3rq%X;dx-I*hnP3)YUx(H0Zv`AzA}2SGy@*qv%Unrf6=P$+W8vP6bIeYYrAi5 zrfR-j^Pd5KxMV%~G%;wMbgk>9s%>RL{{MV}EPkAm}o$yQ!`DY!ru*rTh oKSMIXwq1T{hTzff)ctd7Pg=Z<_pVyU?_IU^(ebzL+TLCMH}J_&Q2+n{ delta 2445 zcmZ`)TZ|Le8J4}fEbFz$ECB?&ENlc~fr0gHe5=yHjJ@NrJ-&Nx&I7W?9?y6@;~9I# zwYLz@Cs??+p=}Uv!s(lEpL@MQhN=@qBZrR*; zI7k2a|NlFm&N=`2zfW(Rd;P|_JNs=GahRVaF%V3Ezr;1O3syNzd2- z*H1zRz|H5Og^j0%XTc9HLHjm-wRmwe=bItN#&3>XdU7bR@%!xj-2+P}E`qt|Z09#t zemcF;{dMN*hc`wa-mpCQ-WKxHDa%QkEAy@j?eAbQSzcuol=b6Gwh&G!EpOWp+nH=W zmrDx+K9Q9h6iV^UmJ-Pl!5mIUqB$g`d1Y_XQz)bYihJ1ZbL~vez;iwD>k{2-lD=+}Y=lI%?ybOTw5}kPh)btgmJ~D+3*$t!6*UpJKPV0dy-GjX zRk)ZU1qaj+SjrP;zy+rj0+-HBIKcN$S@-X*tLFKwH{85a%IKHtSf$~qd3s2Y%Qg69 zy+9%DJe>=gxHrscYLlS-eUqj-^#~<+ab+MRe35LUM0K@zjg2JGRw{y{t(aOd*iZmV z2H_6)ExPL{xVday1Q$+Q7r-6SwhKHQPdn%3V^x?4l@&=Sh61H#l};FFGTNu~8a^Ny z2JU*(O^hN{60I^F$u!fUqAAjt5h|s%h|Z&Ct8KOl%s}m?7^z>x`F2Z(!P>I*nN7;$ zJ47koTS59#oJq2A5gT~ZSh1Js$D%%!AQc^vYq$(o5f?-Hg;WO%vDHMrYEVrw6fEd; zq*y2m9xQL>a)O8GvL${1w{>3{+=1leq{m1u#uRNcqJWTsP=M-sLg|Oeh?bh9;q<0x?4fz@2nGk=;De z8Q_Ag$H1$SZSM|S8Si>(4MDCHf?2BU(dle&7$q7xCTGa%5G^sWVv>uabWamg!X_$umW*MG|^1OOSo3s%7+Cg>RSWy5w$m6s5#c z&6=mdDha`i3oeS$_#u@Drb;Eh(d-Y5dV(Ej?jDjIcc~gFnel3=H~N5>K=*81zrS4M zNUl!k)gII7wGl4phQ<7_OhyAT8K>%mxa#YOB%9XFtW+%L!Z6SJa^5QDMsY#!nB_p4 z-(-FXda!MD=zD(aIe?m~l%~zrq*7w85k#J{A;w zFo8DQZ4aC_k_Din*2T%diU$F=W~M1{&^CQ-{Uh7-=p)7 zCo|{{0v!hF zzt5Zl_chBDIQOpI0dBtl`Mw=P05@wt3AA_Z3^;NTI{fWf|J(WDMd%64xhKHDXLHVZ z@Zx0%+P>LWFGCCC+xhur=oxVDXAlJTtU*KY(%a5CV0FwM2bV5GQ{as?Xy11JYirOU zaDNS&-d>--0v+5`rkR=L?<{Q!;`n|4@7q$V$*%^E?cfeOHj82hcKr%;VmmrE5AK!9 zKJQk6d?n=|`1}fF-_HBslbKWN+*N4AU3F@1!2iv$0M4IvPJ-v}InRvl-F3db@L$Uu B9$5eY