https://github.com/samuel-ricardo/mini-inter_api
https://github.com/samuel-ricardo/mini-inter_api
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/samuel-ricardo/mini-inter_api
- Owner: Samuel-Ricardo
- License: gpl-3.0
- Created: 2021-12-14T16:41:23.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-18T14:22:10.000Z (about 2 years ago)
- Last Synced: 2025-01-14T12:44:11.506Z (5 months ago)
- Language: JavaScript
- Size: 374 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mini Inter API
🚀 🟧 Inter Front-End Developer 🟧 🚀
Application develoepd during a Front End Bootcamp promoted by @Inter in Partnership With @Digital Inovation One
|Â
Project   |  Â
Technologies   |  Â
Routes   |  Â
Run   | Â
Author   |  Â
#
Inter is a Brazilian fintech, with the main function of a 100% digital bank with a 100% tariff free digital account, in addition to being a bank, it has investment, insurance, online shopping platforms, among others, all within a super App.
This API is part of a full-stack project that aims to make a small project of a mini bank based on Inter, with account registration, transfer via pix, transfer history and among others.
#
Site - Mini Inter
Repo [frontend] - Mini Inter Site
This API is hosted on Heroku
#
## :construction: API Routes:
Base URL - https://mini-inter-api.herokuapp.com/
- User Routes - /user
- Create - POST - /signup
- Login - POST - /signin
- Get Logged User - GET - /me
#
- Pix Routes - /pix
- Request - POST - /request
- Pay - POST - /pay/:key
- Get all transactions of user - GET - /transactions
#
All routes have error coverage, some are accessible only to authenticated users, some logics were applied such as: a user cannot send a pix to himself, he cannot pay an amount greater than his balance, among other features
#
🛠Main Technologies and Concepts Studieds:
- Typescript
- @Types
- REST
- Token Authentication
- JWT
- cryptography
- js-base64
- Relational Database
- Postgres SQL
- TypeORM
- Deploy
- Host API
- Heroku
- Middlewares
- Error Coverage
- DTO
- Clean Code
:zap: Run Project
### Open Your Git Terminal and Clone This Repositore:
```git
$ git clone "https://github.com/Samuel-Ricardo/mini-inter_api"
```
### Make pull:
```git
$ git pull "https://github.com/Samuel-Ricardo/mini-inter_api"
```
### Install Dependencies
```cmd
$ npm install || yarn
```
### Run Application
```cmd
$ npm start || yarn start
```
:octocat: Author
Samuel Ricardo
