Skip to content

CurrencyXpress is a modern web application that allows users to convert amounts between various currencies with real-time exchange rates. It also provides a history of past conversions.

License

Notifications You must be signed in to change notification settings

PranavArya37/currencyXpress

Repository files navigation

CurrencyXpress

CurrencyXpress is a modern web application that allows users to convert amounts between various currencies with real-time exchange rates. It also provides a history of past conversions.

✨ Features

  • Real-time currency conversion.
  • Support for a wide range of currencies.
  • Display of conversion history.
  • User-friendly interface.
  • Responsive design for use on multiple devices.

🛠️ Technologies Used

🚀 Getting Started

Prerequisites

  • Node.js (v18 or later recommended)
  • npm (comes with Node.js)
  • A Supabase account and project (for storing conversion history).

Development Setup

  1. Clone the repository:

    git clone <YOUR_GIT_URL>
    cd <YOUR_PROJECT_NAME>
  2. Install dependencies:

    npm install
  3. Set up environment variables: Create a .env file in the root of the project. Add your Supabase project URL and Anon Key:

    VITE_SUPABASE_URL=your_supabase_url
    VITE_SUPABASE_PUBLISHABLE_KEY=your_supabase_anon_key

    You can find these in your Supabase project settings.

  4. Run the development server:

    npm run dev

    This will start the Vite development server, typically at http://localhost:5173.

Available Scripts

  • npm run dev: Starts the development server.
  • npm run build: Builds the application for production.
  • npm run lint: Lints the codebase using ESLint.
  • npm run preview: Serves the production build locally for preview.

🖼️ Screenshots

CurrencyXpress - Full Page
currencyXpress - Full Page
Screenshot 2
currencyXpress - Full Page
Universal Currency Converter Recent Conversions
currencyXpress - Universal Currency Converter currencyXpress - Recent Conversions

🚢 Deployment

This project is built with Vite, which produces a static build in the dist/ directory.

  1. Build the application:

    npm run build
  2. Deploy the dist folder: You can deploy the contents of the dist folder to any static hosting provider, such as:

    Most providers can be connected directly to your Git repository for automatic deployments on push.

🤝 Contributing

Contributions are welcome! If you'd like to contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature-name).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some feature').
  5. Push to the branch (git push origin feature/your-feature-name).
  6. Open a Pull Request.

Please make sure your code adheres to the project's linting rules (npm run lint).

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.


About

CurrencyXpress is a modern web application that allows users to convert amounts between various currencies with real-time exchange rates. It also provides a history of past conversions.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages