Doccure

An awesome README template to jumpstart your projects!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Main Goal
   • Built With
2. Getting Started
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

I came up with the idea after going through the Pandemic, it made the hospitals crowded due to not booking appointments or getting consults on their current health condition and so on. It came to my mind that I should build a platform to make it easy for the patients and doctors to communicate and schedule appointments based on the condition online, I started by building the structure and figuring out which functionalities I need to make it a complete product.

Here's why:

• A website made for scheduling appointments with Clinics, Doctors and Hospitals
• It was made and built by one developer from scratch
• The website has three types of users ("Admin", "Clinic/Doctor", "Patient")
• The Admin is the one who controls everything in the website, starting from users all the way to sensitive users details
• Clinic/ Doctor, those are the ones who will register through our websites and getting approved by the admins to share their expertise and services with patients
• Patients:

  
  

  • New patients can easily register
  • Simple Login and Register
  • Select the clinic services based on the categories
  • Select the city through keyword for view the nearest clinic
  • View all the nearest clinics
  • View the detailed information about the clinic, doctor and images
  • Check the availability and cost
  • Provide ratings and comments
  • Make the simple appointment process

Main Goal

Create a safe environment by giving others the ability to schedule everything online without the need of going to a doctor or clinic and make the place crowded, by doing this it will lowers everyone's chance of getting infected by COVID-19 or any other disease.

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

Frontend

• Bootstrap
• JQuery
• CSS3

Backend

• Redis
• Docker
• Laravel

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo

   git clone https://github.com/laithalenooz/Masterpiece-Laith_Al_Enooz.git

2. Open the terminal in your root directory(project directory) & to install the composer packages run the following command:

   composer install

3. By running the following command, you will be able to get all the dependencies in your node_modules folder:

   npm install

4. To run the project, you need to run following command in the project directory. It will compile the php files & all the other project files. If you are making any changes in any of the .php file then you need to run the given command again.

   npm run dev

5. To serve the application you need to run the following command in the project directory. (This will give you an address with port number 8000.) Now navigate to the given address you will see your application is running.

   php artisan serve

6. To change the port address, run the following command:

   php artisan serve --port=8080 // For port 8080
   sudo php artisan serve --port=80 // If you want to run it on port 80, you probably need to sudo.

7. Watching for changes: If you want to watch all the changes you make in the application then run the following command in the root directory.

   npm run watch

8. Building for Production: If you want to run the project and make the build in the production mode then run the following command in the root directory, otherwise the project will continue to run in the development mode.

   npm run prod

9. Required Permissions: If you are facing any issues regarding the permissions, then you need to run the following command in your project directory:

   sudo chmod -R o+rw bootstrap/cache
   sudo chmod -R o+rw storage

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Laith Al Enooz - @ith_al - [email protected]

Project Link: https://github.com/laithalenooz/Masterpiece-Laith_Al_Enooz