GDSC Advising

Skip all Science Advising hassle and go to GDSC Advising instead!

Ollama setup

Make sure Ollama is installed

  ollama -v

Pull the required Mistral model

  ollama pull mistral:7b-instruct

Mistral should be accessible at port 11434 now through Ollama locally.

Frontend setup

Move to the frontend directory

  cd frontend

Make sure npm is installed

  npm -v

Install dependencies

  npm install

Run development server

  npm run dev

Backend setup

Move to the backend directory

  cd backend

Make sure Python is installed (3.12.1 preferred)

  python -v

Create a virtual environment

  python -m venv venv

Start the virtual environment

  source venv/bin/activate

Install the required dependencies

  pip install -r requirements.txt

Start the application

  sh ./start.sh

Visit http://0.0.0.0:8000 to access the backend (CORS is supported).

Make a query with a POST request to the /db/retrieve endpoint.

curl -X POST "http://0.0.0.0:8000/db/retrieve" \
     -H "Content-Type: application/json" \
     -d '{"text": "What does computer science at UBC teach?"}'

Backend through Docker

Move to the backend directory

  cd backend

Build the image

  docker build -t gdsc-advising-backend .

Start container from image

  docker run --env-file .env -p 8000:8000 gdsc-advising-backend

Start entire application

Use Docker Compose

  docker-compose up