Identity Provider

Identity Provider is an open-source authentication and authorization service designed to secure access to your applications and services. It offers robust identity management and user authentication capabilities, making it a reliable choice for securing your digital assets.

License GitHub Issues GitHub Pull Requests

Welcome to the Identity Provider repository! We appreciate your interest in contributing. This guide will help you get started with contributing to our project. Please take a moment to review this document before you begin. This is a Identity Provider project configured with Passport for centralized identity management. It provides user registration, authentication, password reset, and password change functionality.

Table of Contents

Getting Started

Before you start contributing, you will need to set up your development environment and create a copy of the project on your local machine.

Prerequisites

Before you begin, ensure you have met the following requirements:

Fork the Repository

Click the "Fork" button at the top-right corner of the repository's page. This will create a copy of the repository in your GitHub account.

Clone Your Fork

Clone the repository from your GitHub account to your local machine. Replace thetestcoder with your GitHub username and IdentityProvider with the name of the repository.

Create A Branch

Create a new branch for your contribution. Use a descriptive branch name that reflects the purpose of your changes.

   git checkout -b feature/new-feature

Installation

There are two ways to install this project.

Via Traditional Way of setting up laravel.

  1. Install Dependencies using Composer :

    composer install
  2. Copy .env.example to .env:

    cp .env.example .env
  3. Generate App Key:

    php artisan key:generate
  4. Run the database migrations:

    php artisan migrate
  5. Install Laravel Passport:

    php artisan passport:install

Via Docker

  1. Run Makefile :

    make init

Making Changes

Now you can start making changes to the codebase.

Coding Guidelines

Follow our coding guidelines and best practices. You can find these guidelines in the CONTRIBUTING.md file.

Testing

Make sure to test your changes thoroughly. If there are existing tests, run them to ensure that your modifications do not break any existing functionality. If needed, add new tests for the changes you've made.

Submitting Changes

Once you've made your changes and tested them, it's time to submit your contribution.

Commit your Changes

  git add .
  git commit -m "Add your commit message here"

Push your Changes

  git push origin feature/new-feature

Create a Pull Request

Navigate to the original repository on GitHub and click the "New Pull Request" button. Provide a clear and concise description of your changes in the pull request, and submit it.

License

This project is licensed under the MIT License