Ol-create / Doctors_Appointment_Front_End

Doctors Appointment - Frontend

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 Doctors Appointment - Frontend

The 'Doctors Appointment' frontend is the React framework for the Doctos Appointment application, where users can register and book appointments with doctors throughout the app. This client side application is the frontend repository of this project, built with React using Redux

Doctors Appointment - Frontend is the client repository for building the Doctors Appointment application

🛠 Built With

Tech Stack

This Web App was built using React, using Gitflow and customized Linters

Framework

• React

Manager

• Redux

Toolkit

• Redux-toolkit

Backend

• RoR Backend Repository

Host link

The frontend is hosted in onrender

Key Features

• React for building the frontend framework
• Redux as a building interface

(back to top)

💻 Getting Started

This project was bootstrapped with Create React App, using the Redux and Redux Toolkit template.

Clone the back-end repository and set it up

git clone https://github.com/Ol-create/Doctors_Appointment_Back_End.git
cd doctors_appointment_back_end
bundle install

Note:

Be sure to follow the setting-up instructions of the backend. It needs an .env file to connect to the local PostgreSQL database

After setting-up the back end:

Run the backend repository (in port 3001)

rails s -p 3001

Note that the back-end repository runs in port 3001 (this is important because the .env file of the frontend reads from this port to run the app)

Clone the Frontend repository (use the same shell)

cd ..
git clone https://github.com/Ol-create/Doctors_Appointment_Front_End
cd doctors_appointment_front_end

Install

• In the project directory, install the neccessary packages with the following command:

npm i --legacy-peer-deps

The --legacy-peer-deps options is because of using some older packages of react for using an older version of React

• After installing, run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.\

• You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

• For building the application for deployment:

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

(back to top)

👥 Authors

👤 Paul Oluyemi

• GitHub: @Ol-create
• LinkedIn: LinkedIn

👤 Edith Oga

• GitHub: @vigehi
• LinkedIn: LinkedIn

👤 Lucas Mullen

• GitHub: @mullenlucas
• LinkedIn: LinkedIn

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• To all the collaborators for the Readme Template
• The Microverse Team

(back to top)

📝 License

This project is MIT licensed.

(back to top)