https://github.com/ol-create/doctors_appointment_front_end
https://github.com/ol-create/doctors_appointment_front_end
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ol-create/doctors_appointment_front_end
- Owner: Ol-create
- License: mit
- Created: 2023-01-19T20:24:27.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-09-03T20:06:57.000Z (almost 3 years ago)
- Last Synced: 2025-08-31T11:44:39.782Z (10 months ago)
- Language: JavaScript
- Size: 1.77 MB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Doctors Appointment - Frontend
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#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
> This Web App was built using React, using Gitflow and customized Linters
Framework
Manager
Toolkit
Backend
## Host link
The frontend is hosted in [onrender](https://panghealth.onrender.com)
- **React** for building the frontend framework
- **Redux** as a building interface
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app), using the [Redux](https://redux.js.org/) and [Redux Toolkit](https://redux-toolkit.js.org/) 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)
```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](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](https://facebook.github.io/create-react-app/docs/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](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
👤 **Paul Oluyemi**
- GitHub: [@Ol-create](https://github.com/Ol-create)
- LinkedIn: [LinkedIn](update-link)
👤 **Edith Oga**
- GitHub: [@vigehi](https://github.com/vigehi)
- LinkedIn: [LinkedIn](update-link)
👤 **Lucas Mullen**
- GitHub: [@mullenlucas](https://github.com/mullenlucas)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/lucas-mullen-447312119/)
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
Give a ⭐️ if you like this project!
- Hat tip to anyone whose code was used
- Inspiration
- To all the collaborators for the Readme Template
- The Microverse Team
This project is [MIT](./LICENSE) licensed.