Giter Club home page Giter Club logo

bioentrust_kyc's Introduction

BioEntrust Server Requests

Table of Contents

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

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

Installation

Docker

  1. Pull from Docker hub:
docker pull phenzic/bioentrust_e-verification:v1.0
  1. Run the project:
docker-compose run

Github

  1. Clone the repository:

    git clone [email protected]: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.

License

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

bioentrust_kyc's People

Contributors

phenzic avatar

Watchers

Lucian avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.