Installation

requires:

  • docker
  • python 3.9 (Though I used 3.11, so be warned)
  • npm
  • mysql

python

From within ``backend'' directory:

Install python requirements (presumably within a virtual environment):

pip install -r requirements.txt

docker

From within ``backend'' directory: Docker image: (you may have to start the docker daemon first) To start image:

docker-compose -f docker-compose.yml up -d -V

To stop image and remove all caches/storage:

docker-compose -f docker-compose.yml down -v

To check to make sure it's working:

docker compose exec db_lchackathon2024sp mysql -u root -p

When prompted for a password, enter ``root''. This should take you into a mysql shell.

show databases;

should include ``mind''.

To add tables to database:

alembic upgrade head

react

From within ``frontend'' directory:

npm install

Running

Backend

uvicorn mind_api.main:app --reload

Frontend

npm run dev

Notes for Daniel:

to export requirements.txt:

poetry export > requirements.txt