|
| 1 | +# CollegeGuide |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +## Description |
| 6 | + |
| 7 | +CollegeGuide is a web-based student companion platform designed to connect students across Ireland and make their college lives easier. Built with a "by students, for students" approach, it offers practical academic tools by combining on-demand chatbot support with rich, community-driven interactions through dedicated module-based discussion boards. |
| 8 | + |
| 9 | +## Docker Compose File |
| 10 | + |
| 11 | +```yaml |
| 12 | +services: |
| 13 | + collegeguide-backend: |
| 14 | + container_name: collegeguide-backend |
| 15 | + hostname: collegeguide-backend |
| 16 | + image: ghcr.io/cheeselad/collegeguide-gh-backend:latest |
| 17 | + restart: unless-stopped |
| 18 | + ports: |
| 19 | + - "8000:8000" |
| 20 | + environment: |
| 21 | + - AI_API_KEY=$AI_API_KEY |
| 22 | + - SECRET_KEY=$SECRET_KEY |
| 23 | + - DEBUG=$DEBUG |
| 24 | + - EMAIL_HOST_PASSWORD=$EMAIL_HOST_PASSWORD |
| 25 | + - BASE_URL=$BASE_URL |
| 26 | + depends_on: |
| 27 | + - collegeguide-redis |
| 28 | + network_mode: "host" |
| 29 | + command: > |
| 30 | + sh -c "(python manage.py runserver 0.0.0.0:8000 &) && |
| 31 | + celery -A collegeguide beat" |
| 32 | +
|
| 33 | + collegeguide-frontend: |
| 34 | + container_name: collegeguide-frontend |
| 35 | + hostname: collegeguide-frontend |
| 36 | + image: ghcr.io/cheeselad/collegeguide-gh-frontend:latest |
| 37 | + restart: unless-stopped |
| 38 | + ports: |
| 39 | + - "5173:5173" |
| 40 | + environment: |
| 41 | + - VITE_API_URL=https://collegeguide-api.jakefarrell.ie |
| 42 | + depends_on: |
| 43 | + - collegeguide-backend |
| 44 | + networks: |
| 45 | + - collegeguide-network |
| 46 | + |
| 47 | + collegeguide-blog: |
| 48 | + container_name: collegeguide-blog |
| 49 | + hostname: collegeguide-blog |
| 50 | + image: ghcr.io/cheeselad/collegeguide-gh-blog:latest |
| 51 | + restart: unless-stopped |
| 52 | + ports: |
| 53 | + - "1313:80" |
| 54 | + environment: |
| 55 | + - APP_URL="https://collegeguide-blog.jakefarrell.ie" |
| 56 | + networks: |
| 57 | + - collegeguide-network |
| 58 | + |
| 59 | + collegeguide-redis: |
| 60 | + image: redis:6.2-alpine |
| 61 | + container_name: collegeguide-redis |
| 62 | + hostname: collegeguide-redis |
| 63 | + restart: unless-stopped |
| 64 | + ports: |
| 65 | + - '6379:6379' |
| 66 | + command: redis-server --save 20 1 --loglevel warning |
| 67 | + volumes: |
| 68 | + - cache:/data |
| 69 | + network_mode: "host" |
| 70 | + |
| 71 | +volumes: |
| 72 | + cache: |
| 73 | + driver: local |
| 74 | + |
| 75 | +networks: |
| 76 | + collegeguide-network: |
| 77 | + driver: bridge |
| 78 | +``` |
| 79 | +
|
| 80 | +## Notes |
| 81 | +
|
| 82 | +- Access `collegeguide-backend` at [https://collegeguide-api.jakefarrell.ie](https://collegeguide-api.jakefarrell.ie) (Publicly Accessible) |
| 83 | +- Access `collegeguide-frontend` at [https://collegeguide.jakefarrell.ie](https://collegeguide.jakefarrell.ie) (Publicly Accessible) |
| 84 | +- Access `collegeguide-blog` at [https://collegeguide-blog.jakefarrell.ie](https://collegeguide-blog.jakefarrell.ie) (Publicly Accessible) |
0 commit comments