-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
49 lines (32 loc) · 1.33 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
##backend is live on = https://backend-wallet.onrender.com
# Project Name
Wallet
## Description
This project implements a wallet system with transaction functionality using Node.js, Express.js, and MongoDB.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [API Endpoints](#api-endpoints)
- [Technologies Used](#technologies-used)
## Installation
1. Clone the repository: `git clone <repository-url>`
2. Install dependencies: `npm install`
## Usage
1. Set up a MongoDB Atlas cluster and obtain the connection string.
2. Create a `.env` file in the root directory and add the following environment variables:
3. Start the server: `npm start`
## API Endpoints
## POSTMAN Collection
https://winter-moon-837549.postman.co/workspace/myworld~3bd8400e-3f52-4a51-95c8-2f0abcf108dc/collection/12860517-59b7d3cb-f39f-4199-95ca-9eef95bcde58?action=share&creator=12860517
### Wallet
- `POST /wallet/setup`: Create a new wallet with initial balance.
- `GET /wallet/:id`: Get wallet details by ID.
### Transactions
- `POST /wallet/transact/:walletId`: Create a new transaction for the specified wallet.
- `GET /wallet/transaction/?walletId=`: Get all transactions for the specified wallet.
For detailed request and response examples, refer to the API documentation.
## Technologies Used
- Node.js
- Express.js
- MongoDB
- Mongoose