Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joelbrs/bank.com.br
https://github.com/joelbrs/bank.com.br
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/joelbrs/bank.com.br
- Owner: joelbrs
- Created: 2024-07-09T11:51:35.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-22T14:34:04.000Z (4 months ago)
- Last Synced: 2024-08-02T15:06:43.098Z (3 months ago)
- Language: TypeScript
- Homepage: https://bank.joelf.tech
- Size: 693 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-woovi-challenge - Bank - Bank - Woovi Challenge CRUD FullStack developed by [@joelbrs](https://github.com/joelbrs) (Challenges Fullstack)
README
# bank.com.br
## Project's status: In Development
#### OBS.: This project has resulted in the publication of two articles on my profile in dev.to
- [Idempotência: Melhorando a Resiliência de Seu Sistema - Parte I](https://dev.to/joelbrs/idempotencia-melhorando-a-resiliencia-de-seu-sistema-parte-i-1c99)
- [Idempotência: Melhorando a Resiliência de Seu Sistema - Parte II](https://dev.to/joelbrs/idempotencia-melhorando-a-resiliencia-de-seu-sistema-parte-ii-4p6k)
### 📝 Table of Contents
- [Getting Started](#getting-started)
- [How to Run](#how-to-run)
- [Development](#development)
- [Funcionalities](#functionalities)
- [Screenshots](#screenshots)
- [Authors](#authors)
## 🚀 Getting Started
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
### 📋 Prerequisites
Ensure you have the following installed:
- Git
- Node.js
- pnpm
- Docker
### 🔧 Installation
1. Clone the repository:
```sh
git clone https://github.com/joelbrs/bank.com.br
```
2. Navigate to the client project directory:
```sh
cd ./bank.com.br
```
3. Set environment configuration file in the server and web folder inside app
4. Install dependencies:
```sh
pnpm install
```
## ⚙️ How to Run
1. Start the development server:
```sh
pnpm start:dev
```
2. Start the development web:
```sh
pnpm dev
```
### 🛠️ Built With
- Web:
- [React](https://reactjs.org/) - The library for building user interfaces
- [TypeScript](https://www.typescriptlang.org/) - The programming language
- [Vite](https://vitejs.dev/) - The build tool
- [Relay](https://relay.dev/) - The GraphQL framework
- [TailwindCSS](https://tailwindcss.com/) - The CSS framework
- Server:
- [Node.js](https://nodejs.org/) - The runtime environment
- [Koa](https://koajs.com/) - The web framework
- [TypeScript](https://www.typescriptlang.org/) - The programming language
- [GraphQL](https://graphql.org/) - The query language
- [MongoDB](https://www.mongodb.com/) - The database
- [Jest](https://jestjs.io/) - The tests
## 📋 Functionalities
1. **User Registration**: Allows a user to register using CPF, full name, e-mail and password.
2. **User Confirmation**: Confirms the user's account through a link sent to the registered email.
3. **User Login**: Allows user login using CPF and password or through an access link sent to the registered email (user's account should have be confirmed).
4. **Create Transaction**: Allows you to create a transaction with another user's account.
5. **Detail Transaction**: Allows you to detail a specific transaction that you've made.
6. **Recent Transactions**: Lists the 5 last transactions carried out by the user.
7. **Transaction Metrics**: Displays a graph with the transactions carried out monthly by the user, detailing how many were as a recipient and how many as a sender.
### 📷 Screenshots (Dashboard)
##### Dashboard without transactions made
##### Dashboard with transactions made
##### Dashboard with transaction's graph
##### Create Transaction Modal
##### Resume Transaction Modal
## ✒️ Authors
- **Joel** - _Software Engineer_ - [GitHub](https://github.com/joelbrs), [Linkedin](https://linkedin.com/in/joelbrs)