https://github.com/siva-0310/app_backend
This repository houses a backend prototype for an NFC payment application, developed in Go and powered by MySQL and Redis. It offers essential API endpoints for a seamless payment experience
https://github.com/siva-0310/app_backend
docker docker-compose golang jwt mysql openapi-specification redis
Last synced: 4 months ago
JSON representation
This repository houses a backend prototype for an NFC payment application, developed in Go and powered by MySQL and Redis. It offers essential API endpoints for a seamless payment experience
- Host: GitHub
- URL: https://github.com/siva-0310/app_backend
- Owner: Siva-0310
- Created: 2023-10-09T09:13:05.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-20T04:18:41.000Z (over 2 years ago)
- Last Synced: 2025-03-22T10:48:30.766Z (over 1 year ago)
- Topics: docker, docker-compose, golang, jwt, mysql, openapi-specification, redis
- Language: Go
- Homepage:
- Size: 43.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NFC Payment Application APIs
## Overview
The NFC Payment Application APIs provide a set of endpoints for building a secure NFC payment application. These APIs allow users to perform actions such as registration, login, OTP verification, wallet creation, funds transfer, and accessing transaction history.
## Endpoints
### 1. Register a New User
- **POST /sign_up**
- Registers a new user in the Redis database.
### 2. Login
- **POST /login**
- Allows users to log into the application and sends an OTP for verification.
### 3. Verify OTP
- **POST /otp**
- Used to verify OTP for user authentication and generate a JWT token.
### 4. Create Wallet
- **GET /wallet**
- Allows users to create a wallet.
### 5. Transfer Amount
- **POST /wallet/transfer**
- Enables users to transfer an amount to another person.
### 6. Transaction History
- **GET /wallet/history**
- Provides access to the transaction history.
Please refer to the API documentation for detailed request and response formats.
For detailed information about each API endpoint, their request parameters, and responses, refer to the OpenAPI specification.
## Running the NFC Payment Application with Docker
To run the NFC Payment Application using Docker, follow these steps:
1. **Install Docker:** If you don't have Docker installed on your system, you can download and install it from the [official Docker website](https://www.docker.com/get-started).
2. **Pull the Docker Image:** Use the following command to pull the NFC Payment Application Docker image from the public repository:
```bash
docker pull dockerhub-siva0310/nfc:v0.2