https://github.com/strangeal/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, etc
https://github.com/strangeal/clinixgo
bootstrap5 cancancan jwt postgresql prime-react react-icons react-router reactjs redux redux-toolkit rswag rswag-specs ruby ruby-on-rails swagger-ui webpack
Last synced: about 2 months ago
JSON representation
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, etc
- Host: GitHub
- URL: https://github.com/strangeal/clinixgo
- Owner: Strangeal
- License: mit
- Created: 2023-02-21T13:19:56.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-04-07T12:07:13.000Z (about 2 years ago)
- Last Synced: 2025-04-28T11:22:58.074Z (about 2 months ago)
- Topics: bootstrap5, cancancan, jwt, postgresql, prime-react, react-icons, react-router, reactjs, redux, redux-toolkit, rswag, rswag-specs, ruby, ruby-on-rails, swagger-ui, webpack
- Language: JavaScript
- Homepage: https://clinixgo-production.up.railway.app/
- Size: 42.2 MB
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [Kanban Board](#kanban-board)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run Test](#run-tests)
- [Run Linters](#run-tests)
- [Run Endpoints](#Api-Endpoint-Documentation)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
> 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
> Blog App is backend project
Front-End
Database
> We can do CRUD operations on following things:
- **Doctors**
- **Appoitnments**
- **Users**
- [ClinixGo Live Demo🎈](https://clinixgo-production.up.railway.app/)
## :notebook_with_decorative_cover: Kanban Board
- Link to our [kanban-board](https://github.com/users/Strangeal/projects/3)
- Link to initial [kanban-board-screenshot](https://user-images.githubusercontent.com/20049193/220385323-6515c1e1-0fc1-454c-af09-45e3ab48e94c.png)
- We are **four** in the group.
> 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
```sh
gem install rails
```
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone https://github.com/Strangeal/ClinixGo.git
```
### Install
Install this project dependencies with:
```sh
cd ClinixGo
bundle install
npm install
```
Create the app database:
```sh
rails db:create
rails db:migrate
rails db:seed
```
### Usage
To run the application, run the following command:
```sh
./bin/dev
```
### Run Test
To run app test. run the following commad:
```sh
rspec
```
### Run Linters
To run tests, run the following command:
```sh
rubocop
```
OR
```sh
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`
👨💻 **Justice Bajeri**
- GitHub: [Justice Bajeri](https://github.com/Strangeal)
- LinkedIn: [Justice Bajeri](https://www.linkedin.com/in/justice-bajeri-0b7211243/)
👨💻 **Kwasi Baayeh**
- GitHub: [Kwasi Baayeh](https://github.com/Baayeh/)
- LinkedIn: [Kwasi Baayeh](https://www.linkedin.com/in/kabaayeh)
👨💻 **Felicia G. Awuah**
- GitHub: [Felicia G. Awuah](https://github.com/NahnahAJ)
- LinkedIn: [Felicia G. Awuah](https://www.linkedin.com/in/felicia-awuah-gyedua/)
👨💻 **Hesbon Onchera**
- GitHub: [Hesbon Onchera](https://github.com/Paul-js-hub)
- LinkedIn: [Hesbon Onchera](https://www.linkedin.com/in/paul-onchera/)
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.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project then please give a ⭐️ and also share your feedback using github_issues.
- ❤️ [Murat Korkmaz](https://www.behance.net/muratk)
This project is [Creative Commons] licensed.