Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hebaelshamy/currency-exchange-manager
https://github.com/hebaelshamy/currency-exchange-manager
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/hebaelshamy/currency-exchange-manager
- Owner: HebaElshamy
- Created: 2024-08-11T14:55:48.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-12T13:45:41.000Z (5 months ago)
- Last Synced: 2024-08-13T14:06:20.616Z (5 months ago)
- Language: PHP
- Size: 155 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Currency Management System !!
## Overview
This project is a Currency Exchange Management System designed to allow users to manage their financial records and exchange rates. Users can add, update, and delete their exchange rates and amounts, as well as view their financial records in an organized manner.
## Description
The Currency Exchange Management System provides a user-friendly dashboard where users can:
- Add, view, update, and delete exchange rates for different currencies.
- Manage their financial records, including adding new amounts and viewing them with their respective exchange rates.
- Ensure that all data is kept private and accessible only to the user who created it.
## Solution Overview
- **User Dashboard:** Allows users to interact with their exchange rates and financial records.
- **Exchange Rates Management:** Users can manually add, update, and delete exchange rates from a configuration file.
- **Financial Records Management:** Users can manage their financial records, including adding, updating, and deleting amounts.
## Features
- **Add New Exchange Rates:** Users can add new exchange rates through their dashboard.
- **Update Existing Exchange Rates:** Users can update existing exchange rates.
- **Delete Exchange Rates:** Users can remove exchange rates that are no longer needed.
- **View Exchange Rates:** Users can view all configured exchange rates.
- **Add New Financial Records:** Users can add new financial amounts and associate them with a currency.
- **Update Financial Records:** Users can update existing financial records.
- **Delete Financial Records:** Users can delete financial records.
- **View Financial Records:** Users can view a list of all their financial records with calculated exchange values.
## Backend Highlights
- **Configuration-Based Exchange Rates:** Exchange rates are stored in a configuration file (`config/exchangeRates.php`) which is not tracked in GitHub to protect sensitive data.
- **Database Management:** Financial records are managed through a database, allowing CRUD (Create, Read, Update, Delete) operations.
- **Dynamic File Creation:** The application dynamically creates the `exchangeRates.php` file with default values if it does not exist.
- **Authorization:** Basic checks are implemented to ensure users can only modify their own records.
## Technical Choices
- **Laravel Framework**
- **Configuration File for Exchange Rates**
- **Blade Templating Engine**
- **jQuery for JavaScript Functionality**
- **Git for Version Control**
- **Database Management**
- **Security and Authorization**
## How to Run the Program
1. Clone the repository.
```bash
git clone https://github.com/HebaElshamy/Currency-Exchange-Manager.git
```
2. Install project dependencies using Composer:
```bash
composer install
```
3. Copy the .env.example file and rename it to .env:
```bash
cp .env.example .env
```
4. Generate the application key:
```bash
php artisan key:generate
5. Configure the .env file with your database connection details
6. Install Dependencies
```bash
npm install
```
```bash
npm run dev
```
8. Run the database migrations to create tables:
```bash
php artisan migrate
9. Populate the database with the required data.
```bash
php artisan db:seed --class=UsersTableSeeder
10. Start the local server:
```bash
php artisan serve
11. Open the project in the browser at http://localhost:8000
or http://localhost/Currency-Exchange-Manager/public/
12. To login as an user, use the following credentials:
- Email: [email protected]
- Password: 123456789
- Email: [email protected]
- Password: 123456789
13. Enjoy your experience!
## Interview Task Link
https://github.com/HebaElshamy/Currency-Exchange-Manager/blob/main/task.todo
