/book-an-appointment-capstone

This is the back-end api app for the fullstack application

Primary LanguageRubyOtherNOASSERTION

📗 Table of Contents

📖 Doctors clinic project



Explore the seamless world of healthcare with our clinic management project! Featuring two dedicated repositories for front-end and back-end, our user-friendly platform empowers users to navigate clinic pages, learn about doctors, and book appointments effortlessly. Admin privileges unlock the ability to add doctors seamlessly. Behind the scenes, our robust back-end efficiently manages data operations, including GET, PUT, POST, and DESTROY, ensuring a smooth and secure user experience. Elevate healthcare management with our comprehensive solution.

Link to the Kanban board, which has been set up at the start of the project
Link to the Kanban board, after the project was completed
This project has been completed by 5 team members, you can check out the social media / GitHub profiles in the Author section, or by clicking the link provided below.

(Authors)

🛠 Built With


  • Ruby on Rails (Back End): The powerful Rails framework forms the backbone of our project, seamlessly managing data operations and ensuring a robust server-side architecture.

  • Front-End UI Repository: Explore the dynamic user interface crafted for an intuitive experience. Front-End Repository


Key Features


  • Backend Functionality: Leverage the power of our Ruby on Rails backend to effortlessly recreate the design. Seamlessly manage data operations, including GET, PUT, POST, and DESTROY, ensuring a dynamic and responsive user experience.

  • API Documentation: Explore detailed API endpoints for users, doctors, and reservations in our "documentation" folder. This comprehensive resource provides insights and guidance for seamless integration. Uncover the inner workings of our project with ease.

(back to top)

💻 Getting Started


To get a local copy up and running, follow these steps:

  1. Choose a directory
  2. Open a Terminal

Setup

Backend (Ruby on Rails)

  1. Run the following command to clone the backend repository: 
    git clone https://github.com/agneta1991/book-an-appointment-capstone
  2. Navigate into the backend directory: 
    cd book-an-appointment-capstone
    • Clone this repository to your desired folder:
  • Remove config/master.key and config/credentials.yml.enc if they exist.
  • Run in the terminal: EDITOR=code rails credentials:edit
  • Close the editor that opens.
  • This command will create a new master.key and credentials.yml.enc if they do not exist.

  1. Set up the database:

    rails db:create
rails db:migrate
rails db:seed

  2. Start the Rails server:

    rails server

Frontend (React)

  1. Open a new terminal.

  2. Run the following command to clone the frontend repository:

    git clone https://github.com/wolterbwambale/booking-appointment-capstone_frontend

  3. Navigate into the frontend directory:

    cd booking-appointment-capstone_frontend

  4. Install dependencies:

    npm install

  5. Start the React development server:

    npm start

  6. Visit http://localhost:3000 in your web browser to explore the application. Ensure both the Rails and React servers are running simultaneously for the full experience.

(back to top)

📊 Tests


To test the models, validations and controllers please run the following command in your terminal:
rspec spec

(back to top)

👥 Authors


👤 Agneta Pupienyte

👤 Bhekisile Jozi

👤 IKONDE NEKEMIAH ARNOLD

👤 Yousef Badr

👤 Bwambale Benny Wolter

(back to top)

🔭 Future Features

Exciting enhancements are planned for the future to elevate the clinic project's capabilities. Here's a glimpse of upcoming features:

1. Patient Dashboard:

  • Enhance the patient experience with a personalized dashboard.
  • Provide a comprehensive view of appointment history, prescriptions, and upcoming appointments.

2. Prescription Renewal:

  • Streamline the prescription renewal process for both patients and doctors.
  • Enable patients to request prescription renewals through the platform for a more convenient healthcare experience.

3. Notification System:

  • Keep patients informed with a robust notification system.
  • Implement reminders for upcoming appointments, prescription refills, and other essential health-related information.

4. Advanced Search and Filters:

  • Improve the search functionality for finding doctors.
  • Enable patients to filter doctors based on specific criteria such as specialty, location, and availability.

Stay tuned for these exciting additions to make managing health and appointments even more seamless!

(back to top)

🤝 Contributing Contributions, issues, and feature requests are welcome!


Feel free to check the issues page.

(back to top)

⭐️ Show your support


If you like our project please show your support and give this page a star!

Star

(back to top)

🙏 Acknowledgments



We would like to extend my heartfelt gratitude to Microverse for providing me with the opportunity to undertake this project. Additionally, we are immensely thankful to the code reviewers who takes the time to assess my work and provide valuable feedback, which greatly contributed to the refinement and success of the project. Your guidance and support have been invaluable throughout this endeavor, and I am truly grateful for your contributions.

(back to top)


📝 License

This project is MIT licensed.