README
¶
HeadHome
Your companion, every step of the way
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
Go | Gin | Firebase | Google Maps Platform | Google Cloud Platform
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
- Clone Repo
$ git clone https://github.com/GSC23-HeadHome/HeadHome-Backend.git
- Run the following code in bash to install the required dependencies
$ go get all
- Create a
.envfile 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\,\nand 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>
- 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 XiangNanyang Technological University |
Chang Dao ZhengNanyang Technological University |
Marc Chern Di YongNanyang Technological University |
Ong Jing XuanNanyang Technological University |
Directories
¶
| Path | Synopsis |
|---|---|
|
Package main is the entry point for the backend server of HeadHome-Backend, a project focused on providing a robust and scalable solution to help alleviate the problem of dementia wandering.
|
Package main is the entry point for the backend server of HeadHome-Backend, a project focused on providing a robust and scalable solution to help alleviate the problem of dementia wandering. |
|
Package database provides functionality for managing the connection and interactions with the Firestore database.
|
Package database provides functionality for managing the connection and interactions with the Firestore database. |
|
Package fcm implements push notifications for users by leveraging the Firebase Cloud Messaging (FCM) service.
|
Package fcm implements push notifications for users by leveraging the Firebase Cloud Messaging (FCM) service. |
|
Package firebase_app manages the connection between this server and Firebase, providing initialization and access to the Firebase app instance.
|
Package firebase_app manages the connection between this server and Firebase, providing initialization and access to the Firebase app instance. |
|
Package logic provides utility functions that serve the business logic of the application.
|
Package logic provides utility functions that serve the business logic of the application. |
|
Package models provides data models that represent documents in the Firestore collection.
|
Package models provides data models that represent documents in the Firestore collection. |
|
Package routes provides the implementation of the API routes for the HeadHome-Backend server.
|
Package routes provides the implementation of the API routes for the HeadHome-Backend server. |
|
Package websocket establishes a websocket between different user types for real-time communication.
|
Package websocket establishes a websocket between different user types for real-time communication. |
Click to show internal directories.
Click to hide internal directories.