Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/makkianjum/patient-crest
A patient management system where appointments can be booked
https://github.com/makkianjum/patient-crest
appwrite css javascript nextjs react tailwindcss twilio typescript
Last synced: 27 days ago
JSON representation
A patient management system where appointments can be booked
- Host: GitHub
- URL: https://github.com/makkianjum/patient-crest
- Owner: MakkiAnjum
- Created: 2024-07-27T13:18:52.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-07-29T19:03:03.000Z (3 months ago)
- Last Synced: 2024-10-09T19:21:28.967Z (27 days ago)
- Topics: appwrite, css, javascript, nextjs, react, tailwindcss, twilio, typescript
- Language: TypeScript
- Homepage: https://patient-crest.vercel.app
- Size: 4.16 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Patient Crest
## Healthcare Appointment Management System
This project is a healthcare appointment management system built using cutting-edge technologies to provide a seamless experience for patients and administrators. It leverages **Next.js** for the frontend, **Appwrite** for backend services, **TypeScript** for static typing, **TailwindCSS** and **ShadCN** for styling, and **Twilio** for SMS notifications.
## Table of Contents
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
## Features
- **Register as a Patient**: Users can sign up and create a personal profile as a patient.
- **Book a New Appointment with Doctor**: Patients can schedule appointments with doctors at their convenience and can book multiple appointments.
- **Manage Appointments on Admin Side**: Administrators can efficiently view and handle all scheduled appointments.
- **Confirm/Schedule Appointment from Admin Side**: Admins can confirm and set appointment times to ensure they are properly scheduled.
- **Cancel Appointment from Admin Side**: Administrators have the ability to cancel any appointment as needed.
- **Send SMS on Appointment Confirmation**: Patients receive SMS notifications to confirm their appointment details.
- **Complete Responsiveness**: The application works seamlessly on all device types and screen sizes.
- **File Upload Using Appwrite Storage**: Users can upload and store files securely within the app using Appwrite storage services.
- **Manage and Track Application Performance Using Sentry**: The application uses Sentry to monitor and track its performance and detect any errors.
- **Code Architecture and Reusability**: Designed with modular architecture for code reusability and maintainability.
## Technologies Used
- **Next.js**: A React framework for building fast and user-friendly web applications.
- **Appwrite**: An open-source backend server providing authentication, database, and storage services.
- **TypeScript**: A superset of JavaScript that adds static typing for improved code quality.
- **TailwindCSS**: A utility-first CSS framework for creating responsive designs.
- **ShadCN**: A component library for building modern UIs.
- **Twilio**: A cloud communications platform for sending SMS notifications.
- **Sentry**: A real-time application monitoring tool for detecting errors and performance issues.
## Installation
To set up the project locally, follow these steps:
1. **Clone the repository:**
```bash
git clone https://github.com/makkianjum/patient-crest.git
cd patient-crest
```
2. **Install dependencies:**
Make sure you have [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed on your machine. Then, run:
```bash
npm install
```
3. **Set up Appwrite:**
Follow the [Appwrite documentation](https://appwrite.io/docs) to set up your Appwrite server. Ensure you have your project and database configured.
4. **Set up Sentry:**
Register your project with [Sentry](https://sentry.io/) and obtain your DSN.
5. **Configure Twilio:**
Sign up for a Twilio account and set up your SMS service. Obtain your account SID, auth token, and phone number.
## Configuration
Create a `.env.local` file in the root directory and add the following environment variables:
```plaintext
NEXT_PUBLIC_APPWRITE_ENDPOINT=
NEXT_PUBLIC_APPWRITE_PROJECT=
TWILIO_ACCOUNT_SID=
TWILIO_AUTH_TOKEN=
TWILIO_PHONE_NUMBER=
SENTRY_DSN=
```
## Usage
To start the development server, run:
```bash
npm run dev
```
This will launch the application at `http://localhost:3000`.
### Building for Production
To build the application for production, run:
```bash
npm run build
```
This will generate optimized static files in the `out` directory.
### Running Tests
To run tests, use:
```bash
npm test
```