Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.41 KB

README.md

File metadata and controls

44 lines (30 loc) · 1.41 KB
Raw

DANDI Archive Web Application ci Netlify Status

The DANDI Archive web application (i.e. the dandi-archive frontend).

Develop

Build and Run

git clone https://github.com/dandi/dandi-archive
cd web
yarn install
yarn run serve

Note: On Debian systems, the yarn command is from the unrelated cmdtest package. Instead, install and use yarnpkg.

The web app will be served at http://localhost:8085/.

To be useful, this app requires a server component, which you can run locally; see the instructions.

Test

To fix the code formatting and check for common errors, run:

yarn run lint

Schema Migration

The web app uses TypeScript typings (src/types/schema.ts) that are automatically generated from the dandiset metadata's JSON schema. To change the schema version (and as a result, the types), use the yarn migrate command.

For example, to migrate to schema version 0.5.1, run:

yarn migrate 0.5.1

Environment Variables

  • VITE_APP_SERVER_DOWNTIME_MESSAGE
    • A custom error message displayed when the backend server can't be reached.