https://github.com/abehidek/abank
Side project: fintech services easily at your disposal.
https://github.com/abehidek/abank
Last synced: about 1 year ago
JSON representation
Side project: fintech services easily at your disposal.
- Host: GitHub
- URL: https://github.com/abehidek/abank
- Owner: abehidek
- License: mit
- Created: 2022-11-11T01:42:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-12T00:59:04.000Z (over 2 years ago)
- Last Synced: 2025-01-24T06:12:09.459Z (over 1 year ago)
- Language: Elixir
- Homepage:
- Size: 493 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Abank
Fintech services easily at your disposal.
About •
Key Features •
Getting Started •
Roadmap •
License
## About
A digital bank system made for the SENAI final paper, using Elixir's Phoenix web framwork.
## Key Features
- Account transference via pix and TED/DOC.
- View balance and your transaction history.
- Debit and credit card.
- Pay other people using your card.
- Don't forget to pay your invoice before the due date!.
- Get a loan with your bank.
- Account score calculations made easy!.
## Getting Started
This repository contains the backend written in elixir with a docker-compose.yaml to spin-up a [PostgreSQL](https://www.postgresql.org/) database.
It also contains a Next.js project for client-side application and a Expo React Native project for mobile application.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
- Backend: Elixir and Erlang OTP
- Backend: PostgreSQL (using docker or by installing in your machine)
- Web and Mobile: Node.js
- Mobile: Setup React Native proper environment.
### Installing and Running
Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.
```bash
# Clone this repository
$ git clone https://github.com/[your-github-user]/[your-repository-name]
# Go into the repository
$ cd [your-repository-name]
```
#### Server
```bash
$ cd server
$ docker-compose up -d # -d to detach from shell process
$ sh setup.sh
$ mix phx.server # or iex -S mix phx.server to live interaction
```
#### Web
Needs the server and Node.js with a package manager to be working properly.
```bash
$ cd web
# for npm users:
$ npm install
$ npm run dev
# for yarn users:
$ yarn
$ yarn dev
# for pnpm users:
$ pnpm install
$ pnpm run dev
```
## Roadmap
- [x] Start this README using [abehidek's template](https://github.com/abehidek/readme).
- [ ] Add the Roadmap section for README
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
MIT
## Acknowledgments
Inspiration, code snippets, etc.
- [Phoenix Framework](https://www.phoenixframework.org/)
- [Elixir](https://elixir-lang.org/)
- [Ecto](https://hexdocs.pm/ecto/Ecto.html)
- [Next.js](https://nextjs.org/)
- [React](https://reactjs.org/)
## You may also like...
List of apps or libs that do similar stuff as your project.
- [Dotto-bank](https://github.com/viktormarinho/dotto-bank-web)
- [Moitabank](https://github.com/vitormiura/moitabank/)
- [CAT digital bank](https://github.com/iguoliveira/cat-digital-bank)
---
> [hidek.xyz](https://hidek.xyz) ·
> GitHub [@abehidek](https://github.com/abehidek) ·
> Twitter [@guilhermehabe](https://twitter.com/guilhermehabe)