Axon-Care

Axon-Care is a modern healthcare management application that allows patients to easily register and request appointments, while giving administrators the ability to manage these appointments by scheduling or canceling them. The application is built with a focus on simplicity, efficiency, and scalability, using the latest technologies to ensure a seamless user experience.

Features

Patient Registration: Patients can easily create an account by providing their basic details.
Appointment Requests: Registered patients can request appointments with their preferred healthcare provider.
Admin Dashboard: Admins have access to a dashboard where they can view all appointment requests, and either schedule or cancel them.
Real-time Updates: Patients receive real-time updates on the status of their appointment requests.
Error Monitoring: Integrated with Sentry for comprehensive error monitoring and logging.

Technologies Used

Frontend

Next.js - A powerful React framework for building server-side rendered (SSR) and static web applications.
TypeScript - A typed superset of JavaScript that enhances code quality and maintainability.
Tailwind CSS - A utility-first CSS framework for creating responsive and modern user interfaces.

Backend

Appwrite - A secure and scalable backend server for web, mobile, and flutter applications that provides authentication, database, file storage, and more.

Monitoring

Sentry - A robust error tracking and monitoring tool that helps you identify and fix issues in real time.

Getting Started

Prerequisites

Ensure you have the following installed on your local development environment:

Node.js (v16 or later)
npm or yarn
Appwrite Server (You can set up a local instance or use a cloud version)
Sentry Account (For error monitoring)

Installation

Clone the repository

git clone https://github.com/charlespalmerbf/axon-care-react.git
Install dependencies

Using npm:

npm install

Or using yarn:

yarn install
Set up Appwrite backend
- Follow the Appwrite installation guide to set up your Appwrite server.
- Create a new project in Appwrite and note the project ID.
- Set up the necessary collections (e.g., Users, Appointments) as per the application's requirements.
Configure Sentry
- Sign up for a Sentry account and create a new project.
- Get your DSN (Data Source Name) from Sentry and add it to your environment variables.

Environment Variables

Create a .env.local file in the root of the project and add the following environment variables:

PROJECT_ID=<Your Appwrite Project ID>
API_KEY=<Your Appwrite API Key>
DATABASE_ID=<Your Appwrite Database ID>
PATIENT_COLLECTION_ID=<Your Appwrite Patients Collection ID>
DOCTOR_COLLECTION_ID=<Your Appwrite Doctors Collection ID>
APPOINTMENTS_COLLECTION_ID=<Your Appwrite Appointments Collection ID>
SENTRY_AUTH_TOKEN=<Your Sentry Auth Token>
NEXT_PUBLIC_BUCKET_ID=<Your Appwrite Bucket ID>
NEXT_PUBLIC_ENDPOINT=<Your Appwrite Endpoint>
NEXT_PUBLIC_ADMIN_PASSKEY=<Your Personalized Admin Passkey>

Running the Application

To start the development server:

npm run dev

Or with yarn:

yarn dev

The application will be available at http://localhost:3000.

Building for Production

To build the application for production:

npm run build

Or with yarn:

yarn build

This will create an optimized production build in the .next directory.

Code Quality and Linting

Ensure code quality by running the following commands before committing:

Either npm run lint or yarn lint

Conventional Commits

This project uses a specification called Conventional Commits, please ensure this specification is followed when commiting code to this project.

Guide: https://www.conventionalcommits.org/en/v1.0.0/

Pull Requests, Approvals & Releases

Creating the develop release pull request

Pull Requests made to this project are required in order to merge to develop or main

When submitting a Pull Request, at least one approval is required before merging.

When constructing a release, ensure that a release branch is created based off of the contents of develop, the only changes contained within this branch should be the version numbers in package.json.

The Pull Request should be named as [develop] release vX.Y.Z

Creating the main release pull request

Once this Pull Request has been created, you will need to generate a new Pull Request based off main comparing the develop release branch you have just created, this should ensure that all changes that have been made to develop since the last release are contained within this update.

The Pull Request should be named as [main] release vX.Y.Z

Creating the release tag

Once this has been done and both Pull Requests have been merged, a release tag should be generated, named as vX.Y.Z

Contribution Guidelines

Branching strategy: Use feature branches for new features, hotfix branches for urgent fixes.
Commit message format: Follow the Conventional Commits specification.
Code review process: Ensure code is reviewed and approved by at least one other developer.
Issue tracking and labeling: Use labels to categorize and prioritize issues.