Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ilhamghaza/medicare_node_be
https://github.com/ilhamghaza/medicare_node_be
Last synced: 18 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ilhamghaza/medicare_node_be
- Owner: IlhamGhaza
- License: other
- Created: 2024-12-16T05:09:46.000Z (24 days ago)
- Default Branch: master
- Last Pushed: 2024-12-16T05:44:15.000Z (24 days ago)
- Last Synced: 2024-12-16T06:26:13.038Z (24 days ago)
- Language: JavaScript
- Size: 42 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Medicare Node.js Backend
This is the backend for the Medicare application, built using Node.js and Express, integrated with a MySQL database.
## Table of Contents
- [Medicare Node.js Backend](#medicare-nodejs-backend)
- [Table of Contents](#table-of-contents)
- [Overview](#overview)
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Running the Application](#running-the-application)
- [Using Node.js](#using-nodejs)
- [Using Docker](#using-docker)
- [Project Structure](#project-structure)
- [Replacing Database Package with `mysql`](#replacing-database-package-with-mysql)
- [Contribution](#contribution)
- [License](#license)
- [Contact](#contact)
## Overview
The Medicare Node.js Backend is a RESTful API built using Node.js and Express, designed to handle requests from the frontend and interact with a MySQL database. The backend is structured to provide endpoints for user authentication, data retrieval, and manipulation.
## Features
- Authentication System
- User registration
- User login with JWT token
- Role-based authorization (Admin, Doctor, Patient)
- Patient Management
- Create patient profiles
- Update patient information
- View patient details
- Delete patient records
- Manage patient medical history
- Doctor Management
- Register new doctors
- Update doctor profiles
- View doctor details
- Manage doctor specializations
- Doctor availability tracking
- Appointment System
- Schedule appointments
- View upcoming appointments
- Cancel appointments
- Reschedule existing appointments
- Appointment history
- Medical Records
- Create medical records
- Update patient diagnoses
- Track treatment plans
- Manage prescriptions
- View medical history
- Admin Dashboard
- User management
- System monitoring
- Access control
- Report generation
- Security Features
- Password encryption
- JWT authentication
- Role-based access control
- Secure API endpoints
## Prerequisites
Ensure you have the following installed:
- [Node.js](https://nodejs.org/) (latest version recommended)
- [npm](https://www.npmjs.com/) (comes with Node.js)
- [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/) (if you plan to run the application using Docker)
## Installation
1. **Clone this repository:**
```bash
git clone https://github.com/IlhamGhaza/medicare_node_BE.git
cd medicare_node_BE
```
2. **Install dependencies:**
```bash
npm install
```
3. **Configure database settings**:
The database configuration is stored in config/default.json. The default settings are:
```env
{
"dbConfig": {
"host": "localhost",
"user": "your_username",
"password": "your_password",
"database": "medicare",
"multipleStatements": true,
"timezone": "utc+5:30",
"charset": "utf8mb4"
}
}
```
Replace`your_username` and `your_password` with your MySQL username and password.
## Running the Application
### Using Node.js
1. **Ensure MySQL Server is running:**
Make sure you have a running MySQL instance configured according to the settings in the `.env` file.
2. **Run database migrations (if applicable):**
```bash
npm run migrate
```
3. **Start the server:**
```bash
npm start
```
The server will run at `http://localhost:3000`.
### Using Docker
1. **Run Docker Compose:**
```bash
docker-compose up --build
```
This command will build and start containers for the Node.js application and MySQL.
2. **Access the application:**
Once the containers are running, you can access the application at `http://localhost:3000`.
## Project Structure
```bash
medicare_node_BE/
├── config/
│ └── default.json
├── src/
│ ├── controllers/
│ ├── models/
│ ├── routes/
│ └── app.js
├── docker-compose.yml
├── Dockerfile
├── package.json
└── README.md
```
- `config/`: Contains configuration files.
- `src/controllers/`: Contains logic for handling requests.
- `src/models/`: Contains database model definitions.
- `src/routes/`: Contains API route definitions.
- `src/app.js`: Entry point of the application.
## Replacing Database Package with `mysql`
If you previously used a different database package and wish to switch to the `mysql` package, follow these steps:
1. **Uninstall the previous database package:**
```bash
npm uninstall previous_package_name
```
2. **Install the `mysql` package:**
```bash
npm install mysql
```
3. **Update the database connection code:**
In the file managing your database connection, update the code to:
```javascript
const mysql = require('mysql');
const config = require('config');
const dbConfig = config.get('dbConfig');
const connection = mysql.createConnection({
host: process.env.DB_HOST,
user: process.env.DB_USER,
password: process.env.DB_PASSWORD,
database: process.env.DB_NAME,
port: process.env.DB_PORT
});
connection.connect((err) => {
if (err) {
console.error('Error connecting to MySQL:', err.stack);
return;
}
console.log('Connected to MySQL as id ' + connection.threadId);
});
```
## Contribution
If you'd like to contribute to this project, please fork the repository, create a feature branch, and submit a pull request. Your contributions are appreciated!
## License
[](https://opensource.org/licenses/MIT)
This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International Public License - see the [LICENSE](LICENSE) file for details.
## Contact
If you have any questions or suggestions, feel free to contact us at [email](mailto:[email protected]).