Skip to content

Commit 0de0528

Browse files
authored
README COMPLETED
1 parent 9a032c4 commit 0de0528

File tree

1 file changed

+50
-10
lines changed

1 file changed

+50
-10
lines changed

README.md

Lines changed: 50 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,56 @@
1-
# currnverter
1+
# Currnverter App
2+
![image1](https://github.com/user-attachments/assets/070a5926-057d-4e4a-9c05-b2868950bdb0)
23

3-
A new Flutter project.
44

5-
## Getting Started
5+
## Project Description
6+
The Currnverter App is a simple and intuitive currency converter for quick and accurate conversions. Enter the amount, select the currencies, and get real-time exchange rates. Perfect for travelers, traders, and anyone needing fast conversions on the go.
67

7-
This project is a starting point for a Flutter application.
8+
## Download
9+
<b color="red">To run the app and use on your android device kindly download via the link below.</b>
10+
### https://play.google.com/store/apps/details?id=com.currnverter.currnverter
811

9-
A few resources to get you started if this is your first Flutter project:
12+
## Table of Content
13+
- Installation guide and configuration
14+
- Features
15+
- Architecture
16+
- Contributing
17+
- License
1018

11-
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
12-
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
19+
## Installation guide and Configuration
20+
### The installation process for this project is very straightforward.
21+
1. Fork the repository.
22+
2. Run, <b><i>git clone 'repo-link'</i></b> on your git.
23+
3. You need to get a currency converter API from https://app.exchangerate-api.com/.
24+
4. You need an API from https://app.currencyapi.com/ for the historical data
25+
5. Finally run, <b><i>flutter run</i></b>.
1326

14-
For help getting started with Flutter development, view the
15-
[online documentation](https://docs.flutter.dev/), which offers tutorials,
16-
samples, guidance on mobile development, and a full API reference.
27+
## Features
28+
### Currency Conversion Calculation
29+
- The primary purpose of the app is to help users calculate currency conversions quickly and accurately.
30+
- Users can convert currencies from over 100 countries in just one calculation.
31+
- Real-time exchange rates ensure the most up-to-date conversion values.
32+
- Ideal for travelers, traders, and anyone who needs to perform currency conversions efficiently.
33+
### Legacy Rates
34+
- The app includes a Legacy Rate Tab where users can view historical exchange rates.
35+
- Access past currency rates to understand trends and make informed decisions.
36+
- Perfect for users who need to compare current rates with historical data.
37+
38+
## Architecture
39+
This project uses the flutter Feature-First approach.
40+
Each feature has the Presentation layer, Application layer, Domain layer and Data layer.
41+
This approach helps to give the codebase and the app a consistent structure.
42+
43+
## Contributing
44+
- Everyone interested in this project is welcome to contribute to the project.
45+
- All you need to do is
46+
1. Fork the repo.
47+
2. Clone the repo.
48+
3. You can create a new branch if you want.
49+
4. Make your adjustments.
50+
5. git add and commit your changes.
51+
6. Push your changes.
52+
7. Make a pull request.
53+
8. Your pull request will be tested and merged.
54+
55+
## License
56+
See the <a href="https://github.com/DevAdedoyin/weatherapp/blob/master/LICENSE.MD">LICENSE.md</a> file for license rights and limitations (MIT).

0 commit comments

Comments
 (0)