1. Prepare Your Environment Create an empty folder on your computer where you'd like to install the code for DocDirectory). Open Visual Studio Code (VSCode) - Launch VSCode and navigate to the folder you created by selecting "File" \> "Open Folder" in the top menu.
2. Clone the Repository Access the Terminal - In VSCode, go to the top menu bar and click on "Terminal", then select "New Terminal". In the terminal, enter the following command: git clone https://git.cs.usask.ca/gmj287/370-project.git This will clone the necessary files and code into your current folder.
3. Start the Backend Server Enter the following command in the terminal to move to the backend directory: cd ./backend Enter the command: npm install (install all the required dependencies and packages) To start the backend server, run the command: npm start
4. Launch the Frontend Interface
Open a New Terminal: Use the same method to open a new terminal in VSCode. Navigate to the Frontend Directory by entering the command: cd ./frontend Enter the command: npm install (install all the required dependencies and packages) To start the frontend interface, run the command: npm start
After following these steps, you should have successfully installed and initiated DocDirectory on your system. You can now access it via your web browser using [http://localhost:3000/](http://localhost:3000/)
How to Use DocDirectory
For Doctors:
1. Getting Started: Sign Up or Log In
2. Dashboard:
-Manage Profile: Click "My Profile" to view and edit your profile details.
-Set Availability: Adjust your availability to allow patients to book appointments by selecting "My Availability."
-Appointment Management: Access past and future appointments, add appointment notes, cancel appointments, and view patients' medical history under "My Appointments."
-Articles: Create, edit, delete and access articles to educate and inform patients about health-related topics.
-Reviews: Click on “My Reviews” to view reviews patients have posted about you
For Patients:
1. Getting Started: Sign Up or Log In
2. Browsing Doctors:
-Search Functionality: Use the search bar to find specific doctors by first and last name. Utilize dropdown filters to search by specialties, years of experience, and/or gender.
3. Booking an Appointment:
-Doctor Selection: Click on any doctor listed from the search, to book an appointment with them or view their ratings. -Appointment Process: Enter date, time, and reason for the appointment and click "book now." Access an overview of your appointment history, with options to cancel or book additional appointments.
4. Profile Management: View and Update Profile Access your profile from the search page and navigate to a new page to edit profile information.
5. Reviews: Post and View Reviews Post a review by navigating to the page of the doctor you would like to review. Under the booking menu there is a reviews section where you can post a review by providing a score and a written review, and you can view other peoples reviews as well. Edit and Delete Reviews To edit and delete reviews navigate to either the page of a doctor you have reviewed or to your own profile. If in a doctor’s page in the reviews section beneath the booking your review will be at the top with an edit and delete button. To edit click the edit button and provide a new score and/or written review and press submit. You can cancel an edit with the cancel button. To delete a review press the delete button, which will permanently delete the review. If in your own profile the reviews you have posted for all doctors appear below your personal information. These are all editable and deletable in the same way although only one review can be edited or deleted at a time.
