Phenzic / BioenTrust_KYC

BioEntrust Server Requests

Table of Contents

1. Installation
2. Configuration
3. Contribution
4. Endpoints
   • GET

• License

_Note: development server url: https://auth-teg6.onrender.com

Installation

Docker

1. Pull from Docker hub:

docker pull phenzic/bioentrust_e-verification:v1.0

2. Run the project:

docker-compose run

Github

1. Clone the repository:

   git clone [e-mail]:E-Verification/Auth.git master
   cd Auth

2. Create a virtual environment:

   python -m venv venv

3. Activate the virtual environment:

   • On Windows:

     venv\Scripts\activate

   • On macOS/Linux:

     source venv/bin/activate

4. Install dependencies:

   pip install -r requirements.txt

5. Start the server:

   flask run

Configuration

Configuration settings can be adjusted in the /config dir. Make sure to set the appropriate values for your environment.

Contribution

1. Create a new branch:

   git checkout -b your-branch-name

2. Format the code:

   autopep8 --in-place --aggressive --aggressive --recursive . --exclude venv

   or use black .

3. Add your changes:

   git add .

4. Commit your changes:

   git commit -m "<commit-message>"

5. Push to the newly created branch and open a pull request to the master branch:

   git push origin your-branch-name

Endpoints

GET

Description: Welcome message and documentation link.

Response:

{
  "message": "Welcome to BioEntrust Server",
  "docs": "https://docs.BioEntrust.com"
}

User Requests

For detailed information about the User APIs, refer to the User Documentation.

API Requests

For detailed information about the API-Key APIs, refer to the API Documentation.

APP Requests

For detailed information about the App APIs, refer to the APP Documentation.

Client Admin Documentation

For detailed information about the Client Admin APIs, refer to the Client Admin Documentation.

License

This project is licensed under the MIT License - see the LICENSE file for details.