This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Ruby version
-
System dependencies
-
Configuration
-
Database creation
-
Database initialization
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
...
This README file provides an overview and instructions for the Health Care Center project, which is developed using Ruby on Rails. The project aims to create a web application that functions similarly to a hospital management system, facilitating the management of patient records, appointments, and other related tasks.
- User Authentication: Users can sign up, log in, and manage their accounts.
- Role-based Access Control: Different user roles (e.g., admin, doctor, nurse) have different levels of access and permissions within the system.
- Patient Management: Allows the creation, modification, and deletion of patient records, including personal information, medical history, and contact details.
- Appointment Scheduling: Provides a calendar-based interface for scheduling and managing patient appointments.
- Doctor and Staff Management: Enables the administration of doctors and staff members, including their profiles, specialties, and availability.
- Billing and Invoicing: Supports generating bills and invoices for patient services.
- Prescription Management: Allows doctors to create and manage prescriptions for patients.
- Reporting and Analytics: Provides various reports and analytics related to patient statistics, appointments, and billing.
- Installing MySQL
$ sudo apt install mysql-server
$ sudo systemctl start mysql.service
- Configuring MySQL
$ sudo mysql
$ ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'password';
$ exit
- Run Security Script
$ sudo mysql_secure_installation
- Set up user
$ mysql -u root -p
$ CREATE USER '<your_username>'@'localhost' IDENTIFIED BY '<password_of_the_user>';
$ GRANT ALL PRIVILEGES ON * . * TO '<your_username>'@'localhost';
$ ALTER USER '<your_username>'@'localhost' IDENTIFIED WITH mysql_native_password BY '<password_of_the_user>';
$ FLUSH PRIVILEGES;
- Clone the project repository from GitHub:
$ git clone https://github.com/your-username/HCC-NITK.git
- Navigate to the project directory:
$ cd HCC-NITK
- Set to required Ruby version:
- Check which ruby version you are currently on:
$ ruby -v
- In case, it is different from the version used in the project (check in Gemfile), you need to switch to correct version:
$ asdf local ruby 3.1.3
- Install the required gems:
$ bundle install
- Set up config
Go to "./config/database.yml" Change Username and Password to your MySQL username and password:
username: <user_name>
password: <password>
- Set up the database by running the following commands:
$ rails db:create
$ rails db:migrate
- Start the Rails server:
$ rails server
-- or --
$ rails s
- Open your web browser and visit http://localhost:3000 to access the Health Care Center application.
If you wish to contribute to the Health Care Center project, please follow these guidelines:
- Fork the repository on GitHub.
- Create a new branch for your feature or bug fix.
- Commit your changes and push the branch to your fork.
- Submit a pull request detailing your changes and describing their purpose.