HeadHome Backend

The HeadHome backend is responsible for real-time interactions between the dementia patients, caregivers and volunteers. This ensures that dementia patients can receive timely assistance from caregivers or nearby volunteers and help them to head home safely!

👨🏻‍💻 Technology Stack

Getting Started

This repo contains the backend application for HeadHome. Click here to view the full solution.

Go (Version 1.19+) must be installed to run this application.

⚙️  Steps to Setup

1. Clone Repo

$ git clone https://github.com/GSC23-HeadHome/HeadHome-Backend.git

2. Run the following code in bash to install the required dependencies

$ go get all

3. Create a .env file and insert your Firebase Admin SDK private key and Maps API api key.
   Note: Place the entire Firebase Admin SDK private key json object on a single line and escape all \, \n and quotation(") characters with \. Lastly, surround the json object with double quotations "".

/*.env file*/
FIREBASE_ADMIN_PRIVATE_KEY=<your inline firebase admin private key>
MAPS_API_KEY=<your maps api key>

4. Launch the server at 0.0.0.0:8080

$ go run ./cmd

🔑  Files and Directories

├── cmd
│   └──main.go
├── controllers
│   ├── care_giver_controller.go
│   ├── care_receiver_controller.go
│   ├── map_controller.go
│   ├── sos_controller.go
│   ├── travel_log_controller.go
│   └── volunteers_controller.go
├── database
│   ├── care_giver_collection.go
│   ├── care_receiver_collection.go
│   ├── database.go
│   ├── sos_log_collection.go
│   ├── travel_log_collection.go
│   └── volunteers_collection.go
├── fcm
│   └── fcm.go
├── firebase_app
│   └── firebase_app.go
├── logic
│   ├── direction.go
│   └── util.go
├── models
│   ├── care_giver.go
│   ├── care_receiver.go
│   ├── sos_log.go
│   ├── travel_log.go
│   └── volunteers.go
├── routes
│   └── routes.go
├── websocket.go
│   ├── client.go
│   ├── msg_pump.go
│   ├── websocket.go
│   └── ws_hub.go
├── .env (not included in github repo)
├── .gitignore
├── Dockerfile
├── go.mod
├── go.sum
└── README.md

👥  Contributors

Chay Hui Xiang Nanyang Technological University	Chang Dao Zheng Nanyang Technological University	Marc Chern Di Yong Nanyang Technological University	Ong Jing Xuan Nanyang Technological University