MIRROR-Study-Framework

Workflow for website

Install Node.js

Make sure you have Node.js Version 20 or higher installed - npm comes with Node automatically. To check if you have the right versions installed run:

node -v
npm -v

If Node.js is not installed or your verison is <20, download and install the latest LTS version from the Node.js website.

After installation rerun the commands above to confirm Node.js and npm are installed and up to date.

Create .env file

In backend directory create .env file specify OPENAI_MODEL and OPENAI_API_KEY to the specified model you want to use and your OpenAI key for the LLM to work on the backend

To start website

Clone the Repository

git clone https://github.com/DRAGNLabs/MIRROR-Study-Framework.git
cd MIRROR-Study-Framework

Start the Backend

cd backend
npm install
npm start

This should successfully start the backend on port 3001

Start the Frontend

Open a new terminal and navigate to the github repository

cd my-app
npm install
npm run dev

This should successfully start the frontend at http://localhost:5173/