README.md

📗 Table of Contents

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

📖 [ClinixGo]

The project is based on an app to book an appointment with a health specialist(Doctor). The doctor appointment booking app permits healthcare providers to manage their appointments with increased efficiency while giving reliable management. However, it displays all details of the patients, complete history of appointment, analyses the doctors, saving time, etc.

[ClinixGo] is an appointment booking app

ERD Diagram for Project

🛠 Built With

Tech Stack

Blog App is backend project

Front-End

• Redux
• ReactJs
• Webpack
• Bootstrap
• ReactIcon
• PrimeReact
• ReactRouter

Database

• Jwt
• rswag
• Cancancan
• PostgreSQL
• Swagger-Ui
• Ruby On Rails

Key Features

We can do CRUD operations on following things:

• Doctors
• Appoitnments
• Users

(back to top)

🚀 Live Demo

• ClinixGo Live Demo🎈

(back to top)

📔 Kanban Board

• Link to our kanban-board
• Link to initial kanban-board-screenshot
• We are four in the group.

💻 Getting Started

In order to start with this project do as follows :

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

Prerequisites

In order to run this project you need:

• Mac OS or Linux/Debian (strongly recommended)

  If you are running on Windows, you can use WSL to install Ubuntu.

• Latest version of Node installed
• Latest version of Yarn installed
• Latest version of Ruby installed
• Latest version of Rails installed
• Latest version of PostgreSQL installed

 gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/Strangeal/ClinixGo.git

Install

Install this project dependencies with:

  cd ClinixGo
  bundle install
  npm install

Create the app database:

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

Usage

To run the application, run the following command:

  ./bin/dev

Run Test

To run app test. run the following commad:

  rspec

Run Linters

To run tests, run the following command:

  rubocop

OR

  rubocop -A

it will automatically correct the errors

🔖 Api-Endpoint-Documentation

Run the below commands to generate API documentation routes:

rails g rswag:api:install

(back to top)

👥 Authors

👨‍💻 Justice Bajeri

• GitHub: Justice Bajeri
• LinkedIn: Justice Bajeri

👨‍💻 Kwasi Baayeh

• GitHub: Kwasi Baayeh
• LinkedIn: Kwasi Baayeh

👨‍💻 Felicia G. Awuah

• GitHub: Felicia G. Awuah
• LinkedIn: Felicia G. Awuah

👨‍💻 Hesbon Onchera

• GitHub: Hesbon Onchera
• LinkedIn: Hesbon Onchera

(back to top)

🔭 Future Features

In upcoming weeks, we will add some features as mentioned below

• Add a search feature to allow users to search for doctors.
• Improve the app UI.

(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 this project then please give a ⭐️ and also share your feedback using github_issues.

(back to top)

🙏 Acknowledgments

• ❤️ Murat Korkmaz

(back to top)

📝 License

This project is [Creative Commons] licensed.

(back to top)