https://github.com/unmade/shelf-front

Shelf App Frontend - self-hosted file storage
https://github.com/unmade/shelf-front

headlessui react redux redux-toolkit rtk-query tailwindcss vite

Last synced: 5 days ago
JSON representation

Shelf App Frontend - self-hosted file storage

• Host: GitHub
• URL: https://github.com/unmade/shelf-front
• Owner: unmade
• License: agpl-3.0
• Created: 2021-01-03T12:18:02.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-03-15T21:18:07.000Z (10 months ago)
• Last Synced: 2024-03-15T22:28:28.913Z (10 months ago)
• Topics: headlessui, react, redux, redux-toolkit, rtk-query, tailwindcss, vite
• Language: JavaScript
• Homepage: https://getshelf.cloud
• Size: 1.84 MB
• Stars: 26
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Shelf App

This is frontend for a shelf project - a self-hosted file storage.

![App Preview Light Theme](https://i.imgur.com/S1RV7NJ.png)

![App Preview Dark Theme](https://i.imgur.com/BqjCpfk.png)

## Demo

[https://app.getshelf.cloud](https://app.getshelf.cloud)

## Development

Install dependencies:

```bash

yarn install

```

Run development server:

```bash

yarn start

```

To generate translation file:

```bash

yarn makelocales

```

### Building a Docker image

Normally, a docker image is built in CI whenever there is a new tag.

To build a docker image locally:

```bash

docker build . -t shelf_front:0.1.0 --build-arg api_base_url=http://backend_hostname

```

Sometimes you don't know your backend url in advance. In this case,

it is better to omit the `api_base_url` arg and build a docker image as is.

Then, you could provide the `API_BASE_URL` env variablie when running docker:

```bash

docker run --rm -p "8080:80" -e "API_BASE_URL=http://example.com" shelf-front:0.1.0

```