Skip to content

sajidahmed66/bndx-fake-nid

 
 

Repository files navigation

Fake NID API

A FastAPI-based service for managing fake NID (National ID) records.


Features

  • Create and retrieve NID records
  • Auto-generates 13-digit NIDs
  • SQLite database by default
  • OpenAPI/Swagger documentation

Requirements

  • Python 3.10+
  • Docker (optional, for containerized runs)

Running Locally

  1. Clone the repository:

    git clone <your-repo-url>
    cd FakeNidServer
  2. Create a virtual environment and activate it:

    python3 -m venv venv
    source venv/bin/activate
  3. Install dependencies:

    pip install -r requirements.txt
  4. Run the application:

    uvicorn main:app --reload --host 0.0.0.0 --port 8000
  5. Access the API docs:


Running with Docker

  1. Build and start the container:

    docker-compose up --build
  2. Access the API docs:


Environment Variables

  • The default .env file is set up for SQLite:
    DB_URL=sqlite:///./fakenid.db
    

Project Structure

FakeNidServer/
├── Docker/
│   └── Dockerfile
├── routes/
│   └── nid.py
├── models.py
├── database.py
├── main.py
├── schemas.py
├── services.py
├── requirements.txt
├── .env
├── .gitignore
└── docker-compose.yml

About

This repo is created to test BNDX platform for exchanging data between multiple systems securely

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 95.8%
  • Dockerfile 4.2%