NervaAPI

Table of Contents

• About
• Prerequisites
• Installation
• Configuration
• Running
• License

About

NervaAPI is a RESTful API server for the Nerva blockchain. It provides a simple interface to interact with the Nerva blockchain using HTTP requests.

Prerequisites

• Git
• Python >= 3.10
• MongoDB database- uv package manager
• make (optional)

Installation

1. Clone the repository

    git clone https://github.com/Sn1F3rt/NervaAPI.git

2. Switch to the project directory

    cd NervaAPI

3. Create a virtual environment

   uv venv # or make env

4. Install dependencies

    uv sync --all-extras --no-dev # or make install

Configuration

Copy the config.example.py file to config.py and update the variables.

Running

Development

uv run launcher.py # or make run

The API server will be running at http://localhost:5000.

Production

uv run hypercorn --bind 0.0.0.0:17568 launcher:app # or make run-prod

or if you want to enable SSL support

uv run hypercorn --certfile cert.pem --keyfile key.pem --bind 0.0.0.0:17568 launcher:app # or make run-prod-ssl

The API server will be running at http://localhost:17568. The certificate and key files are required for SSL support.

License

Copyright © 2024-present Sayan "sn1f3rt" Bhattacharyya, The Nerva Project