Home

Welcome to the CaeNDR wiki!

Getting Set Up

These pages outline how to set up the CaeNDR project.

Page	Description
Getting Started	Going from nothing to a working codebase. How to install pre-requisites, configure the project locally, and run.
Environment Variables	An explanation of all the environment variables you'll need to set - what they do, and what types/values they take.
Running the Project Locally	Pre-requisites for running the code modules, including setting up the Docker database proxy.
Setting Up the Site	Once you have the code running, these are tasks you'll need to do with the local dev site to finish setting up your instance of CaeNDR.

Understanding the Project Structure

These pages describe the project structure, from the code to the data.

Page	Description
Understanding the Project Structure	Listing of (a) the individual code modules making up CaeNDR, with some notes on what each does & how they interact, and (b) the shared CaeNDR code package.
Tools & Features	Descriptions of various CaeNDR features, including the "tools" (a bit of an overloaded term). Includes some historical notes and nomenclature, for reference.
String Tokens	Listing of variables used in "tokenized" strings across the site - SPECIES, RELEASE, etc. Description of what these represent, how to use them, and what values are valid.
Data Dependencies	Listing of internal & external data sources for the CaeNDR site.

Making Changes & Managing Content

These pages outline how to update your instance of CaeNDR - both the codebase, and the data / content within.

Page	Description
Deploying New Code	How to deploy new versions of CaeNDR modules - both the site and the standalone modules
Managing Dataset Releases	How to release a new CaeNDR dataset - the required files & locations, and the steps to release.
Managing the SQL Database	Notes on the SQL database tables underpinning data queries across the site & tools. Listing of the tables, what they do & depend on, and how to (re)build them.
Managing Strains & Isotypes	Notes on how to manage strain / isotype data across the site. Largely links out to relevant sections of other pages - collects this information in one place.