Merge branch 'main' of https://github.com/ubclaunchpad/clinical-logging…

… into log-history-page

.gitignore

@@ -1 +1,12 @@
+venv/
+*.pyc
+*.pyo
+*.pyd
+*.pyz
+*.pyw
+*.pyc
+*.pyo
+*.pyd
+*.pyz
+*.pyw
 node_modules

README.md

@@ -13,16 +13,71 @@ Our app will have the following components:
 - Database
 - Transcription
 
+### Project Structure
+```
+├── assets                # assets such as logos, marketing materials, transcription pages, provided to us by Flowleaflets. Please keep them here instead of the `public` folder in frontend
+├── backend                  
+│   ├── routes             # most of the backend code for API routes should be here
+│   ├── ├── ...
+│   ├── index.js           # Code for running the server and some basic routes
+│   ├── package.json             
+│   ├── package_lock.json
+│   ├── .env.example         #example env file          
+│   └── .gitignore             
+└──
+├── frontend             
+│   ├── src
+│   ├── ├── assets
+│   ├── ├── ├── ...
+│   ├── ├── pages         # frontend code for each page should go here
+│   ├── ├── ├── ...
+│   ├── ├── utils         # put util or helper functions that are shared across multiple files here (eg: protectedRoutes)
+│   ├── ├── ├── ...
+│   ├── ├── App.jsx         # Main component of the app, likely do not need to modify this
+│   ├── ├── App.css         # Styles for App.jsx, likely do not need to modify this
+│   ├── ├── index.css         # global css styles go here
+│   ├── ├── main.jsx         # root layout of app, wrap all pages inside it
+│   ├── public             # Use assets folder instead of this one for logos and visual assets
+│   ├── ├── ...
+│   ├── package.json             
+│   ├── package_lock.json
+│   ├── other config files
+│   ├── .env.example         #example env file
+│   └── .gitignore  
+└──
+├── transcription         # All code related to the transcription models should be here
+│   ├── requirements.txt         # list of required python packages
+│   └── testing.py         # run Microsoft Florence 2 model on a test file
+└──
+```
 # Setup
 - Install Node.js and npm
+- Install Python version 3.12 or later
 - Clone the repository
 
 ## Backend - Node.js
 1. 'cd backend' to change directory to backend folder
 2. 'npm install' to install dependencies
 3. 'npm run dev' to run local development server
 
+#### .env file
+1. Create a new `.env` file in the backend directory, where the `.env.example` file is located.
+2. Copy the contents of the `.env.example` file
+3. Fill in with the correct credentials
+
 ## Frontend - React + Vite
 1. 'cd frontend' to change directory to frontend folder
 2. 'npm install' to install dependencies
 3. 'npm run dev' to run local development server
+
+#### .env file
+1. Create a new `.env` file in the frontend directory, where the `.env.example` file is located.
+2. Copy the contents of the `.env.example` file
+3. Fill in with the correct credentials
+
+## Transcription - Python
+1. `cd transcription` to change directory to transcription folder
+2. `pip install -r "requirements.txt"` to install required packages
+3. `python testing.py` or `python3 testing.py` to run the script
+
+NOTE: These packages are in the `requirements.txt` file, but if you get an error telling you to install einops or timm, use `pip install einops timm` to install einops and timm seperately.

assets/.gitignore

@@ -0,0 +1,4 @@
+# Ignore every file in this folder
+*
+# Except this one
+!.gitignore

backend/.env.example

@@ -0,0 +1,3 @@
+SUPABASE_JWT_SECRET=
+SUPABASE_URL=
+SUPABASE_ANON_KEY=

backend/.gitignore

@@ -129,4 +129,6 @@ dist
 .yarn/unplugged
 .yarn/build-state.yml
 .yarn/install-state.gz
-.pnp.*
+.pnp.*
+
+.env

backend/index.js

@@ -1,18 +1,25 @@
-import express from "express";
 import cors from "cors";
+import dotenv from "dotenv";
+import express from "express";
+import authRoutes from "./src/routes/authRoutes.js";
+import logRoutes from "./src/routes/logRoutes.js";
+
+dotenv.config();
+
 const corsOptions = {
     origin: ["http://localhost:5173"],
 };
 const app = express();
+const PORT = process.env.PORT || 8080;
 
 app.use(cors(corsOptions));
+app.use(express.json());
 
-const PORT = process.env.PORT || 8080;
-
-app.get("/api", (req, res) => {
-    res.json({ message: "Hello from server!" });
-});
+//Routes
+app.use('/api/auth', authRoutes);
+app.use('/api/log', logRoutes);
 
 app.listen(PORT, () => {
     console.log(`Server listening on ${PORT}`);
-});
+});
+