trasherdk / hyper-bank

Hyper Bank - We are dealing with accounts (not real)

Hyper Bank

Description

---

Simple NodeJS project with tests and CI/CD.

Structure

---

.
├── bin/
│   └── www
├── config/
│   ├── environments/
│   │   ├── development.js
│   │   └── production.js
│   └── index.js
├── controllers/
│   ├── account.controller.js
│   └── customer.controller.js
├── infra/
│   └── logging/
│       └── logger.js
├── routes/
│   └── index.js
├── logs/
├── services/
│   ├── account.service.js
│   ├── customer.service.js
│   └── transaction.service.js
├── tests/
│   └── routes.tests.js
├── .eslintrc.js
├── .gitignore
├── .travis.yml
├── app.js
├── LICENSE
├── package-lock.json
├── package.json
└── README.md

Installation

---

Hyper Bank requires Node.js v10.16.0+ to run.

Install the dependencies and start the server.

For development environments...

$ cd hyper-bank
$ npm install
$ NODE_ENV=development npm start

Default development port is 3000.

For production environments...

$ NODE_ENV=production && PORT={PORT} npm start

Testing

---

Jest testing command.

NODE_ENV={environment} && PORT={PORT} npm test

Linting

---

To run ESlint.

npm run lint

Postman Docs

---

You can find latest Postman Docs with requests from this link

CI/CD

---

CI => Travis CI

Hyper Banks uses Travis CI for continuous integration. Details

Travis CI is a hosted continuous integration service used to build and test software projects hosted at GitHub.

- Source Stage

If any commits to master branch this stage will triggered.

Future Improvements

---

• In-memory database implementation (can be with mongoose)
• Database migrations
• AWS CloudFormation Templates for CD part of the pipeline
• DI with Awilix
• Error notifications for the container running on AWS ECS Fargate, using AWS CloudWatch and AWS SNS
• Security Improvements

Tech

---

Hyper Bank uses a number of open source projects to work properly:

• Node v10.16.0+
• Express
• Log4js
• Morgan
• Express Validator
• Jest
• ESLint
• Travis CI

License

---

Unlicense

hyper-bank's Issues

Ping

Create IMAP folder.