Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/freddykaberuka/mathematics

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/freddykaberuka/mathematics
Owner: freddykaberuka
License: mit
Created: 2023-09-11T09:21:53.000Z (over 1 year ago)
Default Branch: development
Last Pushed: 2023-10-01T12:24:36.000Z (over 1 year ago)
Last Synced: 2023-10-01T13:49:18.481Z (over 1 year ago)
Language: JavaScript
Size: 1.39 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        



  Math Magician Web App




# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 [Math Magician] 

> is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to:

> Make simple calculations.

> Read a random math-related quote.

## 🛠 Built With 

### Tech Stack 

  Client

  


    React.js

  


### Key Features 

- **[Calculator]**

(back to top)


## 💻 Getting Started 

> this is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to:

> Make simple calculations.

> Read a random math-related quote.

### Prerequisites

In order to run this project you need:

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone https://github.com/freddykaberuka/mathematics.git

```

### Install

Install this project with:

```sh

  cd my-project

  npm install

```

### Usage

To run the project, execute the following command:

```sh

  npm start

```

### Run tests

To run tests, run the following command:

```sh

  npm run test

```

### Deployment

You can deploy this project using:

```sh

  npm run build

```

(back to top)


## 👥 Authors 

> Mention all of the collaborators of this project.

👤 **Author1**

- GitHub: [@githubhandle](https://github.com/freddykaberuka)

- Twitter: [@twitterhandle](https://twitter.com/trojanx07)

- LinkedIn: [LinkedIn](https://linkedin.com/in/kaberuka-freddy-853b08153/)

(back to top)


## 🔭 Future Features 

> we will be having a Mathematics calculator in our web app for calculation and having also the random quotes on about page.

- [ ] **[Calculator]**

- [ ] **[Random math-related quotes]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

> If you like this project fell free to contribute.

(back to top)


## 🙏 Acknowledgments 

> I would like to thank Microverse for the guidance on this project.

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)