1.3.0 • Published 1 year ago
ewalletsystem v1.3.0
E-Wallet System
Getting started
This project will run on NodeJs using MongoDB as database.
Features
- Basic Authentication (Register/Login with hashed password)
- JWT Tokens, make requests with a token after login with
Authorization
header with valueBearer thisisasamplesecret
wherethisisasamplesecret
will be returned in Login response. - Deposit API
- Transfer API
- View transactions API
Software Requirements
- Node.js 8+
- MongoDB 3.6+ (Recommended 4+)
How to install
Using Git (recommended)
- Clone the project from github.
git clone https://github.com/Vectormike/e-Wallet-system ewallet
Using manual download ZIP
- Download repository
- Uncompress to your desired directory
Install npm dependencies after installing (Git or manual download)
cd ewallet
npm install
Setting up environments
- You will find a file named
.env.example
on root directory of project. - Create a new file by copying and pasting the file and then renaming it to just
.env
cp .env.example .env
- The file
.env
is already ignored, so you never commit your credentials. - Change the values of the file to your environment. Helpful comments added to
.env.example
file to understand the constants.
Project structure
How to run
Running API server locally
npm run dev
You will know server is running by checking the output of the command npm run dev
Connected to mongodb:YOUR_DB_CONNECTION_STRING
App is running ...
Press CTRL + C to stop the process.
Note: MONGODB_URL
will be your MongoDB connection string.
1.3.0
1 year ago