https://github.com/batanoffs/mini-finance
Softuniada 2024 Programming Olympiad project submission. Finance web application with basic functionality to add friends, pay them and request money. Tracking history is also implemented.
https://github.com/batanoffs/mini-finance
ant-design css-modules finance-application react react-context react-router-dom transactions vite
Last synced: 10 months ago
JSON representation
Softuniada 2024 Programming Olympiad project submission. Finance web application with basic functionality to add friends, pay them and request money. Tracking history is also implemented.
- Host: GitHub
- URL: https://github.com/batanoffs/mini-finance
- Owner: batanoffs
- License: mit
- Created: 2023-12-30T12:20:17.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-25T08:06:36.000Z (about 1 year ago)
- Last Synced: 2024-10-25T09:53:02.341Z (about 1 year ago)
- Topics: ant-design, css-modules, finance-application, react, react-context, react-router-dom, transactions, vite
- Language: JavaScript
- Homepage: https://mini-finance.onrender.com
- Size: 70.9 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Mini Finance Innovations
[](https://softuniada.softuni.bg/)
[](https://opensource.org/licenses/MIT)
[](https://github.com/prettier/prettier)
[]()
#### Mini Finance Innovations is a finance web application project. The goal is to simulate online banking by generating online virtual cards for new users, enabling users to add friends via phone number, facilitating transactions between friends in the ecosystem, receiving notifications for events, and maintaining transaction history.
> [!NOTE]
> - Deployed at [https://mini-finance.onrender.com](https://mini-finance.onrender.com)
> - Backendless FREE-TIER requests are **LIMITED** and the server will shut down for a day when reached
> - New updates to database, services(introduced Backendless SDK), localization updated to english
## Table of content
- [Features](#features)
- [Libraries and Services](#libraries-and-services)
- [Usage](#usage)
- [Installation](#installation)
- [Project content](#project-content)
- [Design and Architecture](#design-and-architecture)
- [Future updates](#future-updates)
- [Contributing](#contributing)
- [License](#license)
## Features
- Authentication
- Virtual card generation upon register (currently all mock cards have balance)
- Top-up
- Friends and favorites
- Notifications
- User-to-user transactions
- Transaction history tracking with filters
- Autocomplete
- User profile management (picture, profile details etc.)
- Subscription (not implemented)
## Libraries and Services
The project utilizes the following libraries and services:
- [Backendless](https://backendless.com/) as the backend service
- [Exchange Rate API](https://www.exchangerate-api.com/) for real-time exchange rates
- [React-router](https://reactrouter.com/en/main) library
- [React credit card 2](https://www.npmjs.com/package/react-credit-cards-2) library
- [Ant Design](https://ant.design/) library for a few components
- [Font Awesome Icons](https://fontawesome.com/icons) library
| Category | Technologies / Libraries |
| ---------------- | ---------------------------------------------------------- |
| Frontend | `React` |
| Server | `Backendless` |
| UI | `AntDesign`, `react-credit-cards-2` |
| Forms | `custom logic` |
| State management | `React.useContext` |
| API Request | `fetch` |
| Tools | `Git`, `Vite`, `Prettier`, `Npm`, `disable-react-devtools` |
## Usage
Here are some examples of how to use this project:
1. Register
1. Topping up the account using a credit card
1. Add friends
1. Remove friends
1. Making a transaction to another user in the ecosystem of "Mini Finance Innovations"
1. Viewing transactions history
1. Changing profile info and profile picture
1. Interact with notifications
## Installation
To get started with this project, follow these steps:
1. Clone the repository
```bash
git clone https://github.com/batanoffs/mini-finance.git
```
2. Navigate to the project directory: `cd your-project-directory`
3. Install dependencies:
```bash
npm install
```
4. Start the development server:
```bash
npm start
```
5. Open your browser and go to [http://localhost:3000/](http://localhost:3000/) to view the app.
6. Login with test credentials or register new account
## Project content
- ### Login Register
The user can log in to the app with an existing account or register a new one.
The registration is a multi-step process as shown below and clearly displays the user's current stage.
There is validation implemented for the user's input.
| Steps | From left to right: |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|  |  |
|  |  |
- ### About
| Web | Mobile |
| ------------------------------------------------------------------------------------------------ | ------ |
|  | |
- ### Dashboard
Provides a central interface for managing the account, navigation, including virtual
card, balance, last transactions, quick actions and buttons.
| Web | Mobile |
| :------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------: |
|  |  |
- ### User balance
The dashboard contains the information about the current balance of the user for quick financial overview as well virtual card details
- ### Notifications
Provides real-time notifications for friend requests and money transactions to inform
users in real-time. The notifications also display the time when the notification was
created and possible actions, when the user hovers over the notification with the mouse.
*Users can **request money** from other users in the ecosystem as long as they are in their list of friends.The form is invoked from a button located on the dashboard and allows automatic filling / **Autocomplete** of the field if the friend has been found.*
| Friend request | Accept Friend - success message |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|  |  |
| Money recieved | Money request |
| ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|  |  |
| Empty notifications | Message reject |
| ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|  |  |
- ### User profile menu
The user profile menu contains the user's name and avatar and allows the user to navigate between pages.
| Web | Mobile |
| :------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------: |
|  |  |
- ### Profile settings
Users can change information about their account, including email, profile picture
and information about credit card, as well as manage their notifications.
- ### Quick actions
Provides a quick way to execute tasks such as sending money, adding friends,
requesting money, and adding friends to a category of favorite
| Quick actions | Add Friends and transaction buttons |
| :-------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------: |
|  |  |
| Change | Show buttons | Delete |
| :--------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------: |
|  |  |  |
- ### Last transactions
Users can view their transaction history, which shows the last 5 transactions
- ### Autocomplete
- ### Wallet
Shows all movements in the account, as well as quick buttons for
sending money, loading money and searching for an amount
- ### Profile overview
Here the user can view their data and perform actions towards their friends, as well as see who they are
| Overview | Hover friends action buttons |
| :---------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------: |
|  |  |
- ### Help center
Menu for help and frequently asked questions with search functionality (still not implemented)
## Design and Architecture
Serverless architecture, based on Backendless as a provider.
Used Exchange Rate API for live update rates
- ### Reuseable Components
- buttons
- cards
- forms
- lists
- cards
- modals
- inputs
- utils
- ### Context Providers
**AuthContext** provides data of authenticated user to welcomePage
component through useContext from React. Additionally exports useAuthContext()
- ### Custom Hooks
Some of the hooks are reuseable others are not updated yet.
- **useAddFriend()** - *provides handlers and state managing for friends manipulation. Finally it returns:*
- number
- error
- showMessage
- onSubmit
- onChangeNumber
- onFocusClearErrorHandler
- **useExchangeRates()** - *manages the state and requests to the Exchange Rate API. Finally it returns the different rates.*
- **useMessage()** - *returns function message from Ant Design, which takes type and text*
- **useTransactions(type)** - *Accepts type of transaction. It fetches the transactions by type and returns them.*
- **useMakeTransactions(type, toggleModal, showModal)** - *Accepts type of transaction, toggleModal and showModal as props. It manages the state and requests to the transactions. Finally it returns the different rates.*
- friends - array of friends of the user
- values - updated form values
- setValues - a setter function
- setUserInputHandler - updates form values
- onFormSubmitHandler - form submit handler
- onClose - a function to close the modal
- **useForm(initialState, onLogin, onRegister)** - *takes initial state for form, and functions to be called on login and register. Inside it there's also useValidate hook which validates input from user. Finally it returns:*
- values - updated form values
- error - errors if there were any during validation
- changeHandler - updates form values and is used as onChange prop for input
- validateHandler - validates input from user
- onSubmitLogin - checks if request was successful
- resetFormHandler - clears input fields
- onSubmitRegister - checks if request was successful
- onFocusHandler - clears currently focused input field
- **useSessionStorage(key, initialValue)** - *takes key to store in sessionStorage and initial value. Finally it returns:*
- setSessionStorageState - function to set current state
- state - current state
- **useValidate(initialStatе)** - *takes initial state which comes from useForm. Finally it returns:*
- error - state of errors in the current moment
- errorHandler - function that validates errors and sets them in state
- clearErrorHandler - function that clears errors
- **useUploadImage()** - *provides handlers for drag and drop and file input. Returns*
- picture
- error
- handleDrop
- handleDragOver
- handleFileSelect
- **useVirtualCard()** - *returns virtual card number and balance for the current user*
- ### Routers
- The router is located in `src/router.jsx`
- It is created with createBrowserRouter from `react-router-dom`
- ### Constants
- **baseURL** stores base URL for backendless and exchange rate api
- **defaultAuth** stores the default auth state
- **forms** holds regex validations and error messages for the different types
- **rates** stores initial state for the exchange rates
- **uploadSettings** stores max upload file size
- ### Utils
- **assignNewCardId()** - *takes nothing. Generates random number from 0 – 100 and checks if there's already user with such id and if there is, generates new one and returns it*
- **formatDate(date)** - *takes date and returns formatted*
- **balanceFormat(balance)** - *takes balance and returns formatted*
- **errorHandler(error)** - takes the error and returns a custom object format
- **showLastCardDigits(number)** - takes bank card number and returns last four digits
- **sessionStorage(number)** - holds functions to manage the session storage data
- **showLastCardDigits(number)** - takes the card number digits and returns only the last 4
- ### Services
- **authService** for Authentication
- **cardGeneratorService** for Virtual card generation
- **exchangeRateService** for Exchange Rate
- **notificationService** for Notifications
- **transactionService** for Transactions
- **userDataService** for User Data
- ### Database schema - tables and relations
## Future updates
- [ ] oAuth
- [ ] Change notification settings
- [x] Change profile info
- [ ] Age check on register
- [x] Top up account
- [ ] Language change
- [ ] Dark theme
- [ ] Chat bot
- [ ] Help center search topic
- [x] Update subscription plan
- [x] Wallet transactions
## Contributing
This project is maintained by [batanoffs](https://github.com/batanoffs) and tested by [Ivan-0101](https://github.com/Ivan-0101). Currently is not open to additional contributions.
It is inspired by the layout of [Tooplate 2135 Mini Finance Template](https://www.tooplate.com/view/2135-mini-finance).
Some icons are used from [Julia G](https://icons8.com/illustrations/author/627444) at www.icons8.com
## License
This project is licensed under MIT License - see the [LICENSE.txt](https://github.com/batanoffs/mini-finance/blob/main/LICENSE.txt) file for details.