varianteffect/mavedb

MaveDB database web application

Deprecation

MaveDB and mavedb.org are still going strong! However, the code is now split between two other repositories. The Python code powering the API and web backend is stored in VariantEffect/mavedb-api, while the web frontend can be found at VariantEffect/mavedb-ui.

This repository contains an old version of the project which is no longer used or maintained. If you're having a problem with the MaveDB Python package, API, or website, please create an issue on either mavedb-ui (for the website) or mavedb-api (for all other problems).

About

MaveDB is a biological database for Multiplex Assays of Variant Effect (MAVE) datasets. The primary installation of MaveDB is located at https://www.mavedb.org. For more information about MaveDB or to cite MaveDB please refer to the MaveDB paper in Genome Biology.

MaveDB was developed using Python 3.6, but should be compatible with any later Python 3 version. Python 2 is not supported. Running MaveDB requires the following software packaged via Docker:

• Python 3
• PostgreSQL 9.6
• Pandoc 1.9
• Erlang (required by RabbitMQ)
• RabbitMQ

User authentication with OAuth and ORCID iD requires additional setup and may not be suitable for a local development server. See the ORCID API documentation for a description of OAuth and detailed instructions.

See MaveDB Development for a detailed guide on getting up and running locally.

See MaveDB Deployment for a detailed production deployment guide.

See MaveDB Admin for a guide on custom management commands.