Skip to content

nocpiun/calcium

Repository files navigation

Calcium Calculator

Author LICENSE Stars Github Workflow Status Netlify Status

A web-based calculator app

Poster

Description

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

If you encountered any problems or have any ideas, feel free to open an issue to let me know.

Here is the Wiki

Here is the Manual

Why is its name Calcium?

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

What features does it support?

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

Deploy & Use

It is recommended to access Calcium via calcium.js.org. However, if you prefer to deploy it locally or want to contribute to the source code, please proceed to read the following instructions.

Docker

To begin with, you need to make sure you have had Docker installed on your server (or computer).

  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

To begin with, you need to make sure you have had Git & Node.js installed on your server (or computer).

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

If it throws error at this step, try:

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

If you want to make contribution to this repo, just simply begin by modifying the code and starting 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 review the Pull Requests in my spare time.

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