/calcium

📟 A web-based calculator app

Primary LanguageTypeScriptMIT LicenseMIT

Calcium Calculator

Author LICENSE Stars Github Workflow Status Netlify Status

A web-based calculator app

Banner

Description

Calcium is a web-based calculator written in React + Typescript.

If you have any problem or idea, it's welcome to open an issue to let me know.

Here is the Wiki

Here is the Manual

Why its name is Calcium?

Calculator -> calc -> Ca (Chemical Element) -> Calcium

What features does it include?

  • Basic calculating
  • Sigma & Integral & Product calculating
  • Variable creating and storing
  • Function Images Graphing
  • Base conversion
  • Unit conversion
  • Relationship calculating (Thanks to relationship.js)
  • History recording

Deploy & Use

It's recommended to access Calcium by calcium.js.org. But if you want to deploy it locally, please continue reading the following text.

Docker

First, you need to make sure that your server (or computer) has installed Docker.

  1. Pull docker repository
docker pull noahhrreion/calcium:main
  1. Create container
docker run -p 3000:3000 noahhrreion/calcium:main
  1. Enter http://localhost:3000, and you can start using Calcium.

Launch directly

First, you need to make sure that your server (or computer) has installed Git & Node.js.

  1. Clone Git repo
git clone https://github.com/nocpiun/calcium.git
  1. Install dependencies
npm i

If it throws error at this step, you can try:

npm i --force
  1. Launch Calcium
npm run start
  1. Enter http://localhost:3000, and you can start using Calcium.

  2. If you want to make contribution to this repo, then you can set out to modify the code and start debugging!

Contributing

Contributions to Calcium are welcomed. You can fork this project and start your contributing. If you don't know how to do, please follow the instruction Creating a Pull Request from a Fork. And I'll check the Pull Request list in my spare time. I can't make sure that every Pull Request will be checked at once.

Also, you're supposed to run tests before submitting a commit to your PR.

npm run test

Scripts

An explanation of the package.json scripts.

  • start Launch the app
  • build Create a production build
  • test Run tests

LICENSE

MIT