Dictionarry Database Repository

This repository contains the database configurations and backups used by the Dictionarry project, supporting both the Profilarr tool and the Dictionarry website.

Overview

Dictionarry aims to simplify media automation via tailored custom formats and profiles for Radarr and Sonarr. This repository provides the necessary database setup and management instructions.

Prerequisites

• MongoDB: Ensure MongoDB is installed on your system.
• MongoDB Compass: Install MongoDB Compass for a graphical interface to manage your database.
• Bash: Ensure Bash is installed on your system.

Table of Contents

• Setup Instructions
• Usage
  • Restoring the Database
  • Managing the Database with MongoDB Compass
  • Shell Scripts for Database Operations
• Repository Structure
• Contributing

Setup Instructions

1. Install MongoDB and MongoDB Compass by following the instructions in the installation guide.

2. Clone this repository to your local machine.

   git clone https://github.com/Dictionarrry/db.git
   cd db
   

Usage

Restoring the Database

1. Ensure you have cloned the repository and navigated to the project directory.

2. Run the restore.sh script to restore the database from the latest backup file.

   ./scripts/restore.sh
   

Managing the Database with MongoDB Compass

1. Open MongoDB Compass and connect to your local MongoDB instance.
2. Select the "Dictionarry" database to view and manage its collections.

Contributing

• Follow this guide on best practices when contributing: Link

1. Create a new branch for your changes.

   git checkout -b your-branch-name
   

2. Make your modifications to the database using MongoDB Compass.

3. Run the dump.sh script to create a new backup of the modified database.

   ./scripts/dump.sh
   

4. Commit your changes and the new backup file.

   git add .
   git commit -m "Your commit message"
   

5. Push your branch to the remote repository.

   git push origin your-branch-name
   

6. Create a pull request on GitHub to propose your changes.