Naira-X: Your Simple Naira Converter

Naira-X is a straightforward Naira converter designed to simplify currency conversions for Nigerians. A simple, no-frills tool that focuses solely on currency conversion. Quickly convert Naira to various international currencies, like USD, EUR, GBP, and more.

Using the latest Vue3, Vite, TypeScript and other mainstream technology for development. It comes with chart history for all available currencies.

Welcome to the Currency Converter Project!

Contribution Guide

We're excited that you're interested in contributing to this project. Your contributions help make this project better for everyone.

Getting Started

1. Fork the Repository:
   • Create your own fork of the repository.
2. Clone Your Fork:
   • Clone your forked repository to your local machine:

     git clone https://github.com/<your-username>/naira-converter.git

3. Set Up the Development Environment:
   • Install the required dependencies:

     cd naira-converter
     npm install

4. Start the Development Server:
   • Run the development server:

     npm run dev

   • This will start a local development server, and you can access the app in your browser at http://localhost:5173.

Making Contributions

1. Create a New Branch:
   • Create a new branch for your feature or bug fix:

     git checkout -b branch-name

2. Make Your Changes:
   • Make your desired changes to the codebase.
3. Commit Your Changes:
   • Commit your changes with clear and concise commit messages:

     git add .
     git commit -m "Add new feature: Currency conversion from USD to EUR"

4. Push Your Changes to Your Fork:
   • Push your changes to your remote fork:

     git push origin branch-name

5. Create a Pull Request:
   • On GitHub, create a pull request from your branch to the main branch of the original repository.
   • Provide a clear and concise description of your changes in the pull request.

Code Style and Formatting

• Adhere to the existing code style and formatting.
• Use clear and concise variable and function names.
• Write clean and well-documented code.
• Follow TypeScript best practices.

Git Contribution submission specification

• reference vue specification.

  • feat Add new features
  • fix Fix the problem/BUG
  • style The code style is related and does not affect the running result
  • perf Optimization/performance improvement
  • refactor Refactor
  • revert Undo edit
  • test Test related
  • chore Dependency update/scaffolding configuration modification etc.
  • types Type definition file changes
  • wip In development

Code Review

• Be patient during the code review process.
• Address feedback and suggestions from reviewers.
• Be open to alternative approaches and improvements.

Thank you for your contributions! By following these guidelines, you can help make this project even better. If you have any questions or need further assistance, feel free to reach out to the project maintainers.