The ultimate conversion tool.
Explore the docs »

View Website · View on repl.it · Report Bug / Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

mutat.io is meant to be the one and only conversion tool you need - whether that would be for units, timezones, files, or even languages. It also has an extensive documentation, allowing for anyone to extend it and add their own features.

Built With

• node.js and express.js (which both runs the website and allows for an API and usage of node.js libraries)
• repl.it (which is currently the web host and main IDE for the project)
• JQuery
• Font Awesome 5
• math.js
• MathJax
• Love

Getting Started

To run an online copy, clone the repl.it repo and everything needed will be set up automatically.

To get a local copy up and running, follow these simple steps.

Prerequisites

NPM is the only prerequisite you need.

• npm

npm install npm@latest -g

You can also install all the web JS libaries locally, although you will need to replace each source link to use your local file instead.

Installation

1. Clone the repo

git clone https://github.com/ggtylerr/mutat.io.git

2. Install NPM packages

npm install

Usage

Unit conversion can be done on the Units page. Simply select a category by hovering over the category button (by default, it's set to Mass), select the units you want to convert (available on the right), and input the value on the left. The converted value will show on the other input and a detailed calculation can be seen on the bottom. You can also switch around the units by pressing the rotate button on the middle.

(File, language and time conversions are currently not available and will be on a later date.)

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues). You can also see the current projects for a list of planned features to be added.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the LGPL-2.1 License. See LICENSE for more information.

Contact

Tyler Flowers (ggtylerr) - @ggtylerr - ggtylerr_contact@protonmail.com

Project Link: https://github.com/ggtylerr/mutat.io

Acknowledgements

Thank you to the following services/people for making this project possible.

• StackOverflow, which provided 99% of the answers to random coding issues I encountered
• The Wikipedia page for unit conversion, which provided both the techniques and conversion equations/factors for units.
• Any of my friends, colleagues, family, etc, who I pestered to test out versions of the app
• You, for checking out mutat.io!