Giter VIP home page Giter VIP logo

mithqal-culator's Introduction

Mithqál-Culator

The Mithqál-Culator is a Mithqál Calculator (get it?) web application built with Svelte, Astro, and Tailwind CSS that allows users to calculate the value of gold and silver in various currencies in Mithqáls.

What is a Mithqál?

A Mithqál is a unit of weight usually used to measure gold and silver. One Mithqál is 3.642g. This calculation is useful for Bahá'ís who want to calculate the value of gold and silver in Mithqáls for the payment of the Huqúqu'lláh (The Right of God).

Features

  • Can copy the calculated value to the clipboard by clicking on the total price.
  • Displays the date and time of when metals and currency values were last updated.
  • Metals and currencies values update once a day (by calling runMetalsAPI.js in bun run build:prod) and timestamp value is then updated.

Usage

  1. Open the Mithqal Calculator in your browser.
  2. Enter the amount of metal in Mithqal(s) in the input field.
  3. Click on the button to switch between gold and silver.
  4. The calculated value will be displayed in the selected currency.
  5. Click on the calculated value to copy it to the clipboard.

Goal:

The goal of this project was to build something that can be of service, and also practice coding and calling/handling APIs.

Future Features:

  • Add a random Huqúqu'lláh quote under the calculation.
  • Light/Dark mode switch.
  • Language switch.
  • SEO








Development

To run the project locally (if you want?), use the following commands:

# Install dependencies
bun install

# Build the project
    bun run build

    # OR:
    # Call the Metals API and build the project (for production)

    bun run build:prod

# Start the development server
bun run dev

API

The application uses an API to get the current values of gold and silver (from Metals.dev). The API is called in the runMetalsAPI.js script.

The Tools used:

Contributing

Contributions and feedback are welcome! Feel free to open an issue!

mithqal-culator's People

Contributors

nima9 avatar

Stargazers

Jeff Lavezzo avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.