Diagnosy Service

Diagnosy is a service that provides symptom and diagnosis guidance, user management, and chat functionality for medical inquiries.

Table of Contents

• Installation
• Usage
• Routes
• Dependencies
• Contributing
• License

Installation

1. Clone the Repository:

   git clone https:/mdekabs/diagnosy.git

2. Navigate to the Project Directory:

   cd diagnosy

3. Install Dependencies:

   npm install or npm i

4. Configure Environment Variables:

   • Create a .env file in the project root.
   • Add necessary environment variables (DB, DB_PASSWORD, API_KEY).

5. Start the Server:

   npm run server

Usage

To use Diagnosy, follow the installation steps and start the server. The service exposes various routes for user management, authentication, and chat interactions.

Routes

• Create a New User:

  POST /users
  

• User Sign-In:

  GET /sign_in
  

• User Sign-Out:

  GET /sign_out
  

• Retrieve Authenticated User Information:

  GET /users/me
  

• Initiate a Chat Interaction:

  GET /chat
  

For detailed information on each route, refer to the [api_documentation]section in the code repository.

Dependencies

• Express - Web application framework for Node.js.
• Readline-sync - Synchronous Readline for interactively running JavaScript.
• OpenaiService - Custom service for interacting with the OpenAI API.
• Sha1 - Library for generating SHA-1 hash.

Contributors

Ngozi

Title: UI/UX Designer/Team Lead

LinkedIn Profile

Portfolio

Modinat

Title: Frontend Engineer

GitHub Profile

LinkedIn Profile

Portfolio

Michael Adebayo

Title: Fullstack Engineer

GitHub Profile

LinkedIn Profile

Portfolio

Ekabua Mawoda

Title: Backend Engineer

GitHub Profile

LinkedIn Profile

Portfolio