Skip to content

Commit

Permalink
docs: community projects (immich-app#8641)
Browse files Browse the repository at this point in the history
  • Loading branch information
jrasm91 authored Apr 9, 2024
1 parent 327b9bd commit 9e12276
Show file tree
Hide file tree
Showing 6 changed files with 80 additions and 310 deletions.
4 changes: 0 additions & 4 deletions docs/docs/administration/repair-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,6 @@ In any other situation, there are 3 different options that can appear:

- OFFLINE PATHS - These files are the result of manually deleting files in the upload library or a failed file move in the past (losing track of a file).

:::tip
To get rid of Offline paths you can follow this [guide](/docs/guides/remove-offline-files.md)
:::

- UNTRACKED FILES - These files are not tracked by the application. They can be the result of failed moves, interrupted uploads, or left behind due to a bug.

In addition, you can download the information from a page, mark everything (in order to check hashing) and correct the problem if a match is found in the hashing.
Expand Down
12 changes: 12 additions & 0 deletions docs/docs/community-projects.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Community Projects

This page lists community projects that are built around Immich, but not officially supported by the development team.

:::warning
This list comes with no guarantees about security, performance, reliability, or accuracy. Use at your own risk.
:::

import CommunityProjects from '../src/components/community-projects.tsx';
import React from 'react';

<CommunityProjects />
130 changes: 0 additions & 130 deletions docs/docs/guides/api-album-sync.md

This file was deleted.

176 changes: 0 additions & 176 deletions docs/docs/guides/remove-offline-files.md

This file was deleted.

66 changes: 66 additions & 0 deletions docs/src/components/community-projects.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
import Link from '@docusaurus/Link';
import React from 'react';

interface CommunityProjectProps {
title: string;
description: string;
url: string;
}

const projects: CommunityProjectProps[] = [
{
title: 'immich-go',
description: `An alternative to the immich-CLI command that doesn't depend on nodejs installation. It tries its best for importing google photos takeout archives.`,
url: 'https://github.com/simulot/immich-go',
},
{
title: 'ImmichFrame',
description: 'Run an Immich slideshow in a photo frame.',
url: 'https://github.com/3rob3/ImmichFrame',
},
{
title: 'API Album Sync',
description: 'A python script to sync folders as albums.',
url: 'https://git.orenit.solutions/open/immichalbumpull',
},
{
title: 'Remove offline files',
description: 'A python script to remove offline files.',
url: 'https://gist.github.com/Thoroslives/ca5d8e1efd15111febc1e7b34ac72668',
},
];

function CommunityProject({ title, description, url }: CommunityProjectProps): JSX.Element {
return (
<section className="flex flex-col gap-4 justify-between dark:bg-immich-dark-gray bg-immich-gray dark:border-0 border-gray-200 border border-solid rounded-2xl p-4">
<div className="flex flex-col gap-2">
<p className="m-0 items-start flex gap-2">
<span>{title}</span>
</p>

<p className="m-0 text-sm text-gray-600 dark:text-gray-300">{description}</p>
<p className="m-0 text-sm text-gray-600 dark:text-gray-300">
<a href={url}>{url}</a>
</p>
</div>
<div className="flex">
<Link
className="px-4 py-2 bg-immich-primary/10 dark:bg-gray-300 rounded-full hover:no-underline text-immich-primary dark:text-immich-dark-bg font-bold uppercase"
to={url}
>
View Project
</Link>
</div>
</section>
);
}

export default function CommunityProjects(): JSX.Element {
return (
<div className="grid grid-cols-1 xl:grid-cols-2 gap-4">
{projects.map((project) => (
<CommunityProject {...project} />
))}
</div>
);
}
Loading

0 comments on commit 9e12276

Please sign in to comment.