Doctors Appointment - Frontend
π Table of Contents
- π About the Project
- π» Getting Started
- π₯ 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
Manager
Toolkit
Backend
Host link
The frontend is hosted in onrender
Key Features
- React for building the frontend framework
- Redux as a building interface
π» 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
.env
file of the frontend reads from this port to run the app)
Note that the back-end repository runs in port 3001 (this is important because the 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.
π₯ Authors
π€ Paul Oluyemi
- GitHub: @Ol-create
- LinkedIn: LinkedIn
π€ Edith Oga
π€ Lucas Mullen
- GitHub: @mullenlucas
- LinkedIn: LinkedIn
π€ Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
βοΈ Show your support
Give a βοΈ if you like this project!
π Acknowledgments
- Hat tip to anyone whose code was used
- Inspiration
- To all the collaborators for the Readme Template
- The Microverse Team
π License
This project is MIT licensed.