Skip to content

Getting Started

This guide will help you get started with the API Credential service.

Prerequisites

Before you begin, make sure you have the following:

  • Python 3.12 or higher
  • Docker (optional, for containerized deployment)
  • Access to the Karned platform

Installation

Local Development

  1. Clone the repository: 

    git clone https://github.com/karned-kommon/api-credential.git
cd api-credential

  2. Create a virtual environment and activate it: 

    python -m venv .venv
source .venv/bin/activate  # On Windows, use: .venv\Scripts\activate

  3. Install dependencies: 

    pip install -r requirements.txt

  4. Run the application: 

    uvicorn main:app --reload

The API will be available at http://localhost:8000.

Docker Deployment

  1. Build the Docker image: 

    docker build -t api-credential --platform=linux/amd64 .

  2. Run the container: 

    docker run -p 8000:8000 api-credential

Configuration

The API Credential service can be configured using environment variables or a configuration file. See the configuration documentation for more details.

Authentication

To authenticate with the API, you need to obtain an API token. See the authentication documentation for more details.

Next Steps