Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emilijadunoska/brainy
Brainy: A Mobile Mental Health Chat Application powered by OpenAI API.
https://github.com/emilijadunoska/brainy
Last synced: 25 days ago
JSON representation
Brainy: A Mobile Mental Health Chat Application powered by OpenAI API.
- Host: GitHub
- URL: https://github.com/emilijadunoska/brainy
- Owner: emilijadunoska
- Created: 2023-10-01T14:07:02.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-12-20T23:45:15.000Z (about 1 year ago)
- Last Synced: 2023-12-21T01:50:03.468Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 56.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Brainy
## Features
1. User Authentication: Users can securely create an account and log in to the application.
2. Chat Interface: The application provides a chat interface where users exchange messages.
3. Mental Health Therapy: ChatGPT acts as a mental health therapist, providing support, guidance, and resources to users.
4. User Profiles: Users can create and manage their profiles, including personal information and settings.
5. Chat History Summary: The application summarizes users' chat history, allowing them to review past conversations.
6. Personalized Greetings: Based on chat history, the application greets users with personalized messages to create a more inclusive experience.
7. Reminders: The application sends reminders to encourage users to use the platform and engage in therapeutic conversations.
8. Prompt Engineering for improved response generation.
## Installation
To install and run the application locally, follow these steps:
1. Clone the repository to your computer:
```javascript
git clone https://github.com/PetrovskiBojan/Brainy
```
2. Navigate to the project folder.
```javascript
cd brainy
```
3. Install the required dependencies using npm or Yarn:
```javascript
npm install
```
or
```javascript
yarn install
```
5. Launch the application:
```javascript
expo start
```
6. Use the Expo Client app on your mobile device or emulator to run the application.
For detailed instructions on setting up Expo and running the application on different platforms, refer to the [Expo Documentation](https://docs.expo.dev/get-started/installation/)
## Usage
Once the application is installed and running, users can follow these steps to utilize its features:
1. Launch the application on your mobile device.
2. Create a new account or log in with existing credentials.
3. Customize your notification settings before getting started.
4. The application will guide the user to the chat interface, where they can begin conversations.
5. Share information and engage in conversations about thoughts, feelings, or concerns with the chatbot.
6. Access your profile to edit personal information and settings.
7. Receive personalized greetings from ChatGPT based on chat history.
8. Receive reminders to encourage app usage and participation in therapeutic conversations.
## Technologies
The Brainy application is built using the following technologies:
1. React Native: JavaScript framework for building mobile applications.
2. Firebase: Comprehensive platform for mobile and web app development, providing authentication and a database.
3. SonarQube: Static code analysis.
4. Jira: Work organization and tracking tool.
## Authors
- Bojan Petrovski ([email protected])
- Emilija Dunoska ([email protected])
- Tanja Grozdani ([email protected])
**University:** [University of Maribor](https://www.um.si/en/home-page/)
**Faculty:** [Faculty of Electrical Engineering and Computer Science](https://feri.um.si/)
**Program:** Information Systems and Communication Technologies
**Supervisor:** Prof. Dr. Sašo Karakatič
© 2023 All rights reserved.