Supportly

Supportly is an AI-powered chat application designed to provide users with mental health support. Whether you're going through a tough time or just need someone to talk to, Supportly is here to help. The AI behind Supportly listens to your concerns, provides guidance, and offers resources to help you manage your mental health.

Features

• AI Chat Support: Engage in conversations with our AI, trained to provide empathetic and supportive responses.
• User Authentication: Secure login and account management for personalized support.
• Responsive Design: Accessible on both desktop and mobile devices, ensuring support is always within reach.
• Real-Time Messaging: Instant responses and interactive conversations with the AI.
• Secure and Private: Your conversations are confidential and securely stored.

Getting Started

Follow these instructions to set up the project locally on your machine.

Prerequisites

• Node.js (v14 or higher)
• npm or yarn

Installation

1. Clone the Repository

   git clone https://github.com/VriaA/Supportly.git

2. Navigate to the Project Directory

   cd supportly

3. Install Dependencies

   Using npm:

   npm install

   Or using yarn:

   yarn install

4. Run the Application

   Using npm:

   npm run dev

   Or using yarn:

   yarn dev

5. Open in Browser

   The application should be running at http://localhost:3000.

Usage

• Start a New Chat: After logging in, click on "New Chat" to start a conversation with the AI.
• Ask Questions: Type your questions or concerns in the chatbox and receive real-time responses.
• Explore Resources: The AI might suggest helpful articles, exercises, or contacts based on your conversation.

Contributing

We welcome contributions from the community to enhance Supportly. To contribute, please follow these steps:

1. Fork the Repository

   Click the "Fork" button at the top-right of the repository page to create a copy of the repository under your GitHub account.

2. Clone Your Fork

   git clone https://github.com/your-username/supportly.git
   cd supportly

3. Create a Branch

   git checkout -b feature/your-feature-name

4. Make Your Changes

   Implement your feature or fix.

5. Commit Your Changes

   git commit -m "Add feature/your-feature-name"

6. Push to Your Fork

   git push origin feature/your-feature-name

7. Create a Pull Request

   Go to the original repository on GitHub and click "New Pull Request" to submit your changes for review.

Contact

If you have any questions, feel free to reach out:

• Email: [email protected], [email protected], [email protected]

---

Supportly is not a replacement for professional mental health services. If you are in crisis or need immediate assistance, please contact a mental health professional or emergency services.