brandon/uiowaATR
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Brandon Egger 2023-04-19 09:02:28 -05:00
parent 8fd149a8a2
commit b568e99c86
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -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.