/dropbox-browser-mui

Trivial Material-UI based Dropbox Browser

Primary LanguageTypeScript

Dropbox Browser MUI

Trivial Material-UI based Dropbox browsing app.

CI Status

Platform Status
GitHub Continuous Integration Continuous Deployment Release
SonarCloud Reliability Rating Maintainability Rating Security Rating
Bugs Code Smells Vulnerabilities
Coverage

Getting started

Development environment

The easiest way to get up and running is by using Nix and Direnv. This project makes use of the experimental Nix Flakes and therefore requires to enable that feature as well.

For more info about this topic refer to the corresponding blog post from Determinate Systems.

Dropbox API

In order to access the Dropbox V2 API, an access token is required. This can be generated on a per-app basis via the Developer Console.

The access token then needs to be provided via an enrivonment variable:

$ export VITE_DROPBOX_ACCESS_TOKEN=<token>

Developing

npm start

Runs the app in development mode on http://localhost:5173.

Hot reloading will be available, and compilation or linting errors will also be displayed inside the browser.

npm run lint

Run the linter.

npm run lint:fix

Run the linter and fix auto-fixable issues.

npm test

Run the test cases.

npm test:watch

Launches the test runner in interactive watch mode.

Building

nix build

Builds the application, optimized for production. Afterwards you can copy the resulting ./result/lib/node_modules/dropbox-browser-mui/dist directory on a host and serve it with your favourite http server.

nix build .#docker

Creates a Docker image archive based on the build directory, which then can be loaded into the Docker daemon via docker load < result. It can then be run with docker run -p 3000:80 <image>:<tag>.