README.md

XRPL-Backend

Table of Contents

• XRPL-Backend
  • Table of Contents
  • Introduction
  • Technology Stack
  • Setup and Installation
  • Environment Variables
  • License

Introduction

XRPL-Backend is a server-side application that leverages XRPL's NFTs to provide a secure, decentralized, blockchain-based contract service.

Technology Stack

• Backend:

  • Node.js: A JavaScript runtime for building server-side applications.
  • Express: A web application framework for Node.js.
  • TypeScript: A statically typed superset of JavaScript that adds types and compiles to plain JavaScript.
  • XRPL: A library for interacting with the XRP Ledger.

• Frontend:

  • React: A JavaScript library for building user interfaces.
  • TypeScript: A statically typed superset of JavaScript that adds types and compiles to plain JavaScript.
  • Vite, ESLint, and Prettier: Tools for building the application, linting code, and formatting code.
  • Tanstack Query and Zustand: Libraries for managing application state.
  • Tailwind and Shadcn/ui: Libraries for styling the application and managing layout.

Setup and Installation

Follow these steps to set up and run this project locally:

1. Clone the repository:

   git clone https://github.com/ashtech15/xrpl-backend.git

2. Navigate to the project directory:

   cd xrp-backend

3. Install dependencies:

   npm install

4. Start the development server:

   npm run dev

Environment Variables

This project uses the following environment variables:

• PORT: The port on which the backend server runs.
• XRPL_PROVIDER: The URL of the XRP Ledger provider.
• CORS_ORIGIN: The origin allowed to access the server (for CORS policy).

You can set these environment variables in a .env file in the root of your project. Remember to replace the example values with your actual values.

PORT=''
XRPL_PROVIDER = ''
CORS_ORIGIN = ('', '')

License

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