Axon-Care is a modern healthcare management application that allows patients to easily register and request appointments.
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.
Ensure you have the following installed on your local development environment:
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
Configure Sentry
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>
To start the development server:
npm run dev
Or with yarn:
yarn dev
The application will be available at http://localhost:3000
.
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.
Ensure code quality by running the following commands before committing:
Either npm run lint
or yarn lint
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 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
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
Once this has been done and both Pull Requests have been merged, a release tag should be generated, named as vX.Y.Z