jellyfin-expo/README.md

48 lines
3.2 KiB
Markdown
Raw Normal View History

2020-06-25 14:42:23 +00:00
<h1 align="center">Jellyfin Mobile</h1>
<h3 align="center">Part of the <a href="https://jellyfin.org">Jellyfin Project</a></h3>
---
2019-08-29 04:49:31 +00:00
<p align="center">
2020-06-25 14:42:23 +00:00
<img alt="Logo banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true"/>
<br/><br/>
<a href="https://github.com/jellyfin/jellyfin-expo/blob/master/LICENSE"><img alt="MPL-2.0 license" src="https://img.shields.io/github/license/jellyfin/jellyfin-expo"></a>
<a href="https://github.com/jellyfin/jellyfin-expo/releases"><img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-expo.svg"/></a>
<br/>
<a href="https://opencollective.com/jellyfin"><img alt="Donate" src="https://img.shields.io/opencollective/all/jellyfin.svg?label=backers"/></a>
<a href="https://features.jellyfin.org"><img alt="Feature Requests" src="https://img.shields.io/badge/fider-vote%20on%20features-success.svg"/></a>
<a href="https://forum.jellyfin.org"><img alt="Discuss on our Forum" src="https://img.shields.io/discourse/https/forum.jellyfin.org/users.svg"/></a>
<a href="https://matrix.to/#/+jellyfin:matrix.org"><img alt="Chat on Matrix" src="https://img.shields.io/matrix/jellyfin:matrix.org.svg?logo=matrix"/></a>
<a href="https://www.reddit.com/r/jellyfin"><img alt="Join our Subreddit" src="https://img.shields.io/badge/reddit-r%2Fjellyfin-%23FF5700.svg"/></a>
<br/><br/>
<a href="https://apps.apple.com/us/app/jellyfin-mobile/id1480192618?mt=8" style="display:inline-block;overflow:hidden;background:url(https://linkmaker.itunes.apple.com/en-us/badge-lrg.svg?releaseDate=2020-02-09&kind=iossoftware&bubble=ios_apps) no-repeat;width:135px;height:40px;"></a>
2019-08-29 04:49:31 +00:00
</p>
2020-06-25 14:42:23 +00:00
Jellyfin Mobile is a mobile app built with [Expo](https://expo.io/) primarily targeting iOS devices. We welcome all contributions and pull requests! If you have a larger feature in mind please open an issue so we can discuss the implementation before you start. We use [Github Projects](https://github.com/jellyfin/jellyfin-expo/projects) as a general roadmap for releases.
2019-08-29 04:49:31 +00:00
## Build Process
### Getting Started
1. Clone or download this repository.
```sh
git clone https://github.com/jellyfin/jellyfin-expo.git
cd jellyfin-expo
```
2020-01-17 18:13:39 +00:00
2. Install build dependencies using yarn in the project directory.
2019-08-29 04:49:31 +00:00
```sh
2020-01-17 18:13:39 +00:00
yarn install
2019-08-29 04:49:31 +00:00
```
3. Start the build tools.
```sh
2020-01-17 18:13:39 +00:00
yarn start
2019-08-29 04:49:31 +00:00
```
4. Follow the directions in the terminal or browser window to open on a device or emulator.
2020-06-25 14:42:23 +00:00
## FAQ
* **What is the difference between this and other Jellyfin app projects?**
* This app (Jellyfin Mobile) is a web wrapper based on Expo with some native enhancements. It is available on the [App Store](https://apps.apple.com/us/app/jellyfin-mobile/id1480192618?mt=8) for iPhone and iPad.
* [Jellyfin Player iOS](https://github.com/jellyfin/jellyfin-client-ios) is a newer effort to create a media playback app in native Swift. It is a work in progress and currently only supports media playback.
* [Jellyfin React Client](https://github.com/jellyfin-archive/jellyfin-react-client) an early project to create a single multiplatform app based on React Native. This project has been archived as we have changed direction to utilize native web wrappers on most platforms.