https://github.com/vectormike/lite-bank
A basic digital bank
https://github.com/vectormike/lite-bank
Last synced: 11 months ago
JSON representation
A basic digital bank
- Host: GitHub
- URL: https://github.com/vectormike/lite-bank
- Owner: Vectormike
- Created: 2022-03-11T00:56:27.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-11T01:31:00.000Z (about 4 years ago)
- Last Synced: 2025-03-28T05:43:08.615Z (about 1 year ago)
- Language: TypeScript
- Size: 38 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Lendsqr API
This application allows you to create an account while being able to deposit, transfer and withdraw from it.
## Manual Installation
If you would still prefer to do the installation manually, follow these steps:
Clone the repo:
```bash
git clone --depth 1 https://github.com/Vectormike/lite-bank
cd lite-bank
```
Install the dependencies:
```bash
npm install
```
Set the environment variables:
```bash
cp .env.example .env
# open .env and modify the environment variables (if needed)
```
### Commands
Run the migration:
```
knex migrate:latest
```
Start the server in development"
```
npm run dev
```
Run in production
```
npm run serve
```
Start up the containers
```
docker-compose up -d on the root directory of the project
```
Run Migration
```
docker exec -t -i app knex migrate:latest
```
### Database schema
## API Documentation
To view the list of available APIs and their specifications, vist [Postman API documentation](https://documenter.getpostman.com/view/5622145/UVsHT7j6)
### API Endpoints
List of available routes:
**Auth routes**:\
`POST /api/auth/register` - register\
`POST /api/auth/login` - login\
**Account routes**:\
`POST /api/account/deposit` - fund\
`POST /api/account/transfer` - transfer\
`POST /api/account/withdraw` - withdraw\
## Features
- **MySQL database**: [MySQL](https://www.mysql.com) object data modeling using [Knex](https://knex.com)
- **Authentication and authorization**: using [passport](http://www.passportjs.org)
- **Validation**: request data validation using [Joi](https://github.com/hapijs/joi)
- **Logging**: using [winston](https://github.com/winstonjs/winston) and [morgan](https://github.com/expressjs/morgan)
- **Testing**: unit and integration tests using [Jest](https://jestjs.io)
- **Dependency management**: with [NPM](https://npm.com)
- **Environment variables**: using [dotenv](https://github.com/motdotla/dotenv)
- **Compression**: gzip compression with [compression](https://github.com/expressjs/compression)
- **Docker support**
- **Git hooks**: with [husky](https://github.com/typicode/husky) and [lint-staged](https://github.com/okonet/lint-staged)
- **Linting**: with [ESLint](https://eslint.org) and [Prettier](https://prettier.io)
- **Editor config**: consistent editor configuration using [EditorConfig](https://editorconfig.org)
## Environment Variables
The environment variables can be found and modified in the `.env` file. They come with these default values:
```bash
# Port number
NODE_ENV=development
PORT=8000
BASE_URL_DEV=http://localhost:8000
BCRYPT_SALT=12
REFRESH_TOKEN_SECRET=hththjjkekdkkkdkd
JWT_AUTH_SECRET=kdkdkkdkk
ELK_VERSION=7.5.1
DB_NAME=lendsqr
TEST_DB_NAME=lendsqr_test
DB_HOST=127.0.0.1
DB_PORT=8889
DB_USERNAME=root
DB_PASSWORD=root
```
## Project Structure
```
src\
|--components\ # Modules for each services
|--config\ # Database, jwt and redis configuration
|--database\ # Migrations
|--errors\ # Error handlers
|--helpers\ # Helpers
|--middlewares\ # Custom express middleware
|--shared\ # Utility classes and functions
|--tests\ # Unit tests
|--app.js # Express app
|--server.js # App entry point
```