COMPSCI 520 Project: SchedulCare

SchedulCare: A one-stop healthcare portal. We are building a healthcare portal where both doctors and patients can interact seamlessly. There is a MapView using which patients can navigate to their nearest ambulance, doctor, any medical healthcare facility, among others, and also take advantage of our find by pincode functionality to find closest places. Doctors can set their appointment availability and patients can book their appointments. There is calendar and date features used to set up appointments. Post appointment setting, patients can make a Payment via payment options (we have configured PayPal for this project). There is a AI Health Assistant to help with any user queries regarding any healthcare related suggestions. There are 2 dashboards, one for login and one for register, one each for doctor and patient. We have added MultiFactor Authentication to secure Doctor and patient logins. In addition to that, we have a check for Doctors while they register, to upload their Doctor certificate, to ensure safety and avoid any malpractice.

Instructions to install, configure and set up the project are provided below:

Client setup

Pre-Requisites : Node (22.9.0 or higher) and npm

1. Navigate to client\ dir

2. Install all the client libraries using the command

   npm install

3. To start the client application, run

   npm start

   The application runs on localhost:3000

Server setup

1. Install fastapi. Run from server dir

   pip install -r requirements.txt

2. Navigate to server/app dir and set your python path

   export PYTHONPATH=$PWD

3. Run the server

   fastapi dev main.py

Adding endpoints [devs only section]

1. Create a file for your module if does not exist
2. Add your routes in the file. Refer to patient_router.py
   • Use APIRouter to create child routes
3. Add your router in main.py with the prefix

Connecting with Mongo

1. Once done creating a Mongo account and getting added to the database. Create a .env.dev file in the server directory.
2. Create a variable in the said file MONGO_URI=<your_mongo_url>
   • When getting the Mongo URL, select the language to be Python.
   • DO NOT COMMIT this file. (thanks!)

Using cypress testing

Once done creating an end-to-end test in client/cypress/e2e,

1. Stop the server. Inside server/app/, export mongo db creds: export MONGO_URI="mongodb+srv://:@animus.piv6r.mongodb.net/?retryWrites=true&w=majority&appName=Animus"
2. Start the server: fastapi dev main.py 3.Run npx open cypress in the client folder. Make sure the application is already running.

For running Payment page e2e test, you need to configure your own sandbox email and password since it is third party payment.

Backend Unit Testing

1. Run unit tests for backend services using pytest.
2. Move to server/app folder
3. Install pytest package.
4. Run unit tests using the command pytest tests/ to run all tests.
5. To run a single test, use command pytest tests/payment_test.py.

Paypal Payment Gateway Setup (Sandbox version)

Get client ID and client secret

PayPal integrations use a client ID and client secret to authenticate API calls:

1. A client ID identifies an app. You only need a client ID to get a PayPal payment button and standard credit and debit card fields.
2. A client secret authenticates a client ID. To call PayPal APIs, you'll exchange your client ID and client secret for an access token. Keep this secret safe.

Exchange your client ID and client secret for an access token. The access token authenticates your app when calling PayPal REST APIs. You can call the PayPal OAuth API in any language.

Here's how to get your client ID and client secret:

1. Select Log in to Dashboard and log in or sign up.
2. Select Apps & Credentials.
3. New accounts come with a Default Application in the REST API apps section. To create a new project, select Create App.
4. Copy the client ID and client secret for your app.

Add the Client ID and Client Secret in .env file with keys PAYPAL_CLIENT_ID and PAYPAL_CLIENT_SECRET

Get sandbox account credentials

The PayPal sandbox is a test environment that mirrors real-world transactions. By default, PayPal developer accounts have 2 sandbox accounts: a personal account for buying and a business account for selling. You'll get the login information for both accounts. Watch sandbox money move between accounts to test API calls.

Take the following steps to get sandbox login information for business and personal accounts:

1. Log into the Developer Dashboard.
2. Select Testing Tools > Sandbox Accounts. You can create more sandbox accounts by selecting Create account.
3. Locate the account you want to get credentials for and select ⋮
4. Select View/Edit Account to see mock information such as the account email and system-generated password.
5. Go to sandbox.paypal.com/signin and sign in with the personal sandbox credentials. In a separate browser, sign in with the business sandbox credentials.
6. Make API calls with your app's access token to see sandbox money move between personal and business accounts.

Testing Payment Flow SchedulCare

1. Patient schedules appointment with doctor.
2. This action is redirects to Payment Page
3. Checkout using Paypal option to test using sandbox credentials.
4. Use the test Sandbox account credentials. Remember to use personal sandbox credentials for this flow. Business sandbox credentials are for merchants.
5. Once logged in, authorise the payment.

Email Notification Setup (mailtrap.io SMTP Service)

1. Ensure you have FastAPI-Mail installed. Install them using:

   pip install fastapi-mail

2. Mailtrap Account: Sign up for a free account at Mailtrap to obtain SMTP credentials.

Configure Mailtrap SMTP Settings

1. Log in to your Mailtrap account.

2. Navigate to Inboxes → Select your inbox.

3. Find SMTP credentials:

   1. Host: sandbox.smtp.mailtrap.io
   2. Port: 587
   3. Username:
   4. Password:

4. Add the Username and Password in .env file with keys MAIL_USERNAME and MAIL_PASSWORD

How to View Received Emails in Mailtrap

1. Log in to Mailtrap.io
2. After logging in, you’ll land on the Dashboard.
3. Under the Inboxes section, you’ll see a list of your inboxes.
4. Select the inbox where you’ve configured your SMTP credentials (usually the default "My Inbox").
5. Once inside the selected inbox, you’ll see a list of received emails.
6. Click on any email to open and view its content.

Setting up MultiFactor Authentication

Download and setup Google Authenticator App from the Play Store or the App Store

My Authenticator code doesn't work?

Due to the time lag between PyOTP and Google Authenticator web servers, the code expires after 30secs. In this case, wait until Authenticator creates a new code

Google Maps Embed API key

1. Follow the setup instructions from the Maps Embed API page
2. Add the API key as one of your environment variables as REACT_APP_GOOGLE_MAPS_API_KEY

   export REACT_APP_GOOGLE_MAPS_API_KEY=<your_api_key> >> ~/.zshrc

3. Restart your terminal and navigate to the client directory to restart the client application.

   [!WARNING]
   You need to add the API key in your system environment variables to avoid exposing it in the codebase.
   Do not add it in the .env.dev file.

GEMINI API credentials for using the AI Health Assistant

1. Visit the link: https://ai.google.dev/gemini-api/docs/api-key
2. Click on "Get a Gemini API key in Google AI Studio"
3. Once inside this page, Click "Create API Key"
4. Once you have generated your api key, configure this api key inside .env.dev file like this: GEMINI_API_KEY="<your_api_key>"
5. Now you are good to go!