https://github.com/boydwo/bank-clean-code-nestjs
Clean Code REST API in NodeJS with Nest.js and PrismaORM that simulates a banking system.
https://github.com/boydwo/bank-clean-code-nestjs
Last synced: about 1 month ago
JSON representation
Clean Code REST API in NodeJS with Nest.js and PrismaORM that simulates a banking system.
- Host: GitHub
- URL: https://github.com/boydwo/bank-clean-code-nestjs
- Owner: boydwo
- Created: 2022-06-23T18:25:28.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-01-09T18:29:39.000Z (over 1 year ago)
- Last Synced: 2024-04-28T05:47:27.688Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 210 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Description
The goal of this test is to develop a REST API in NodeJS with Nest.js that simulates a banking system.
These are the endpoints that you should include:
1. Create account;
2. Make a deposit;
3. Get account balance;
4. Get account statement;
5. Transfer amount between two accounts;
6. Make a withdrawal;
# Getting started (1 min)
Make sure to have docker installed, otherwise [install it here](https://docs.docker.com/get-docker/).
1. Clone the project
```
git clone https://github.com/boydwo/bank-clean-code-nestjs.git
```
2. Fetch dependencies
```
npm install
```
3. Copy the `.env.example` file over to your own `.env` file.
4. Mount docker container and start server
```
docker-compose up
```
5. Running migrations
```
npx prisma migrate dev
```
6. Open the Swagger Documentation on http://localhost:3000/docs
7. Run unit tests
```
npm run test:unit
```
8. Run e2e tests
```
npm run test:e2e
```