From b568e99c8632762bd9e309b6f8d1d2d4c959a0c3 Mon Sep 17 00:00:00 2001 From: Brandon Egger Date: Wed, 19 Apr 2023 09:02:28 -0500 Subject: [PATCH] update README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 31f3fc5..9c614ea 100644 --- a/README.md +++ b/README.md @@ -22,3 +22,11 @@ TODO ## API Access Documentation and updates to our RPC backend API are planned for the future. As of now there is no official documentation for accessing our resources database. More information to come! + +## Directory Breakdown +Many directories have associated README's to provide related directory information. + +- ***src/*** - source directory for nextjs frontend/backend application. +- ***data/*** - Non-application (application referring to excelProcessor or frontend) specific data such as the ATR data excel sheet which has multiple uses in each application. +- ***prisma/*** - Prisma schema and seeding of admin account (specified in env). +- ***excelProcessor/*** - Main excel processing backend server and CLI utility for uploading the ATR data excel sheet to MongoDB. \ No newline at end of file