ebonyauth v1.0.3

Ebony Auth Package

Ebony Auth Package is a comprehensive authentication solution for managing user authentication processes in the PHR Mymedical Backend. This package provides all the necessary features and functionalities required for authenticating a user, including model setup, sign-up, OTP verification, password reset, forgot password, and login.

Tools Used

The backend of Ebony Auth Package is built using the following technologies and tools:

• JavaScript and TypeScript: The primary programming languages used for the development of the backend code.
• MySQL: The chosen database management system for storing and managing medical data.
• Sequelize: An ORM (Object-Relational Mapping) library for Node.js, used for simplified database interaction and query management.

Getting started

Setting-up development environment

Step 1. Clone the repo && install the packages in the package.json file

$ git clone https://github.com/Ebonytechnologyy/Mymedical_PHR_BE.git
$ npm install

Step 2. Create a .env file in the root folder

Then copy and paste the content from .env.example file into the .env file

Step 6. Start development server

$ npm run start

Step 7. Working Locally

Check to see if you are on the main branch on system (Make use of Git bash for ease)

Then update your main branch by running the following command:

$ git pull

Then checkout from your local main branch by running:

$ git checkout -b new_branch_name

Work on the new created branch and push and create a Pull Request