ckhor002 / gscintouch

InTouch

Mental Health Application!

View Demo · Report Bug · Request Feature

Greatly appreciate contributions from @jingshenggg, @zhenyong25, @CKHOR002 and @jiawei99

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. Contact
5. Acknowledgments

About The Project

InTouch is a mobile application aimed at improving mental health. It allows users to access psychological first aid courses and provides a platform for users to receive consultations from trained befrienders or psychological first aiders.

We aim to offer an APP to have the following features:
*Video and voice consultation feature for users with mental health issues
*Text diary feature for users to record their daily experiences and emotions
*Sentiment analysis feature to provide users with feedback on their diary entries
*Reward system for users to earn points and redeem them for vouchers
*Psychological first aid courses for befrienders to improve their ability to assist individuals with mental health issues
*Scenario-based quizzes with GPT3 Turbo API analysis for befriender skill validation
*Consultation feature for qualified psychological first aiders to provide assistance to users with mental health issues

(back to top)

Built With

Here are major frameworks/libraries used to bootstrap this project.

• Dart
• Flutter
• Firebase

(back to top)

Getting Started

Below are instructions on setting up the project locally.

Prerequisites

This is an example of how to get a local copy up and running.

• For Android Studio and IntelliJ: https://flutter.dev/docs/development/tools/android-studio
• For Visual Studio Code: https://flutter.dev/docs/development/tools/vs-code

Installation

1. Clone the repo

   git clone https://github.com/CKHOR002/GSCINTOUCH.git

2. Install packages

   flutter pub get

3. Configure .env file

i. Open terminal and navigate to the project folder
ii. Run cp .env.example .env
iii.Fill in the .env file with the details that you have gathered in the following steps as shown below
iv. Modify .env file in the root of the application by following actions.

Steps:
OpenAI API Key

1. Go to https://platform.openai.com/overview to sign up or login to open ai account.
   
2. Go to "Personal" tab on the top right of the page.
   
3. Select "View API keys"
   
4. Create a new secret key if you do not have one.
   
5. Copy your secret key and paste it to the OpenAIAPIKey variable in .env file.
   

Consulation API Key

1. Go to the 100ms.live website and click on the "Sign up" button at the top right corner of the page.
   
2. Fill out the registration form with your email address and password. You can also sign up using your Google or Github account.
   
3. Once you have signed up and logged in, you will be redirected to the dashboard. From there, click on the "Create new room" button.
   
4. Select ‘Video Conferencing’ as the template.
   
5. After successful creation, you can go to Developer sections through the navigation bar.
   
6. You can find a App Access Key and a App Secret.
   
7. Copy your App Access Key and App Secret Key and paste them to the 100msAppAccessKey and 100msAppSecret variable respectively in .env file.
   
   

Google Cloud Platform API Key

1. Log in to the Google Cloud Console (https://console.cloud.google.com/).
   
2. Select the project for which you want to create the service account from the drop-down menu at the top of the page.
   
3. Click on the "IAM & Admin" menu from the left-hand side of the page.
   
4. Select "Service accounts" from the sub-menu.
   5.Click on the "Create service account" button at the top of the page.
   
5. Enter a name for the service account, and optionally, a description.
   
6. Select the appropriate role for the service account from the "Role" drop-down menu. If you are not sure which role to choose, you can select "Project" and "Editor" to give the service account full access to the project.
   
7. Click on the "Create" button.
   
8. Once the service account is created, click on the "Create key" button in the "Keys" tab.
   
9. Select the "JSON" format and click on the "Create" button.
   
10. A JSON file containing the API key will be downloaded to your computer. This file contains the private key that you will need to authenticate with the Google Cloud APIs.
    
    {
    "type": "service_account",
    "project_id": "",
    "private_key_id": "COPY THE PrivateKeyID FROM HERE",
    "private_key": "COPY THE PrivateKEY FROM HERE",
    "client_email": "[email protected]",
    "client_id": "112907106975140504099",
    "auth_uri": "https://accounts.google.com/o/oauth2/auth",
    "token_uri": "https://oauth2.googleapis.com/token",
    "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
    "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/audiototext%40intouch-
    378205.iam.gserviceaccount.com"
    }
    
11. Copy the private key from the private_key_id field and private_key in the JSON above and paste it into APPACCESSKEY and APPSECRET variable in .env file.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

(back to top)

Contact

Khor Chin Yi - [email protected]

Project Link: https://github.com/CKHOR002/GSCINTOUCH

(back to top)

Acknowledgments

• Flutter Documentation
• Get to know Firebase for Flutter

(back to top)