https://github.com/skyv26/effective-octo-robot

https://github.com/skyv26/effective-octo-robot

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/skyv26/effective-octo-robot
• Owner: skyv26
• Created: 2025-04-15T07:30:26.000Z (over 1 year ago)
• Default Branch: develop
• Last Pushed: 2025-04-19T06:16:44.000Z (over 1 year ago)
• Last Synced: 2025-04-19T06:57:51.086Z (over 1 year ago)
• Language: HTML
• Size: 650 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# 🏥 Receptionist & Doctor Portal App 

> A modern web application built with **Ruby on Rails 7+**, providing a unified portal for **Receptionists** and **Doctors** to manage and visualize patient data effectively. The app demonstrates robust authentication, role-based access, and real-time interactions using **Turbo Streams**, while offering a responsive, dockerized development environment.

## 🛠 Built With 

### Tech Stack 

Framework & Language

  


    
Ruby on Rails 7+

  


Database

  


    
PostgreSQL

  


Frontend & Styling

  


    
Stimulus

    
Turbo Streams

    
Tailwind CSS

  


Authentication & Authorization

  


    
Devise

    
Cancancan

  


Other Tools

  


    
Chartkick

    
Docker + LiveReload

  


---

### Key Features 

- 🧾 **Single Login Page** for all roles (Receptionist, Doctor, Admin, Superadmin)

- 👩‍💼 **Receptionist Portal** to register and manage patients (CRUD)

- 🩺 **Doctor Portal** to view patients and visualize registration trends with charts

- 📈 **Patient Graph** with Chartkick showing number of registrations per day

- 🧪 **Role-Based Access** using Cancancan (Superadmin, Admin, Doctor, Receptionist)

- 📱 **Responsive Design** with Tailwind CSS

- 🔐 **Secure Authentication** with Devise

- 🧭 **Landing Page** for enhanced UX

- 🔄 **Turbo Streams** for real-time updates

- 🐳 **Dockerized Environment** for simplified setup

- 👀 **Conditional Rendering** based on roles and permissions

---

## 🚀 Live Demo 

> Demo available soon!

---

## 💻 Getting Started 

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

### Prerequisites

- Ruby >= 3.1

- Rails >= 7

- Docker & Docker Compose

- Node.js & Yarn (optional if not using Docker)

---

### Setup

Clone the repository:

```bash

git clone https://github.com/skyv26/effective-octo-robot.git

cd effective-octo-robot

```

---

### Install & Run with Docker

```bash

docker-compose build

docker-compose up

```

> The app should be running at `http://localhost:3000`

---

### Install & Run Manually

```bash

bundle install

yarn install

rails db:setup

bin/dev

```

---

## 👥 Authors 

👨‍💻 **Aakash Verma**

- GitHub: [@skyv26](https://github.com/skyv26)

- Twitter: [@vrma_aakash](https://twitter.com/vrma_aakash)

- LinkedIn: [skyv2022](https://linkedin.com/in/skyv2022)

---

## 🔭 Future Features 

- 📝 Patient Notes or Medical History

- 📆 Appointment Booking & Management

- 🔔 Notification System for patient registration

- 📤 Export patient reports (PDF/CSV)

- 🌐 Deployment on Render/Heroku

---

## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

- Fork the repo

- Create your feature branch (`git checkout -b feature-name`)

- Commit your changes (`git commit -m 'Add some feature'`)

- Push to the branch (`git push origin feature-name`)

- Open a pull request

---

## ⭐️ Show your support 

If you like this project, please ⭐️ the repository and share your thoughts!

---

## 🙏 Acknowledgements 

- Rails Community

- Hotwire Team

- Tailwind Labs

- Devise & Cancancan maintainers

- Chartkick for awesome visualizations

---

## 📝 License 

This project is [MIT](./LICENSE) licensed.

---