https://github.com/ashmalzahra/math-magicians

This project is about building the core functionality of a calculator and is, a full website that includes 3 sub-pages. A medium-fidelity wireframes has been used to create a UI.
https://github.com/ashmalzahra/math-magicians

deployment jest react-router reactjs single-page-app unit-testing

Last synced: about 1 month ago
JSON representation

This project is about building the core functionality of a calculator and is, a full website that includes 3 sub-pages. A medium-fidelity wireframes has been used to create a UI.

• Host: GitHub
• URL: https://github.com/ashmalzahra/math-magicians
• Owner: ashmalzahra
• License: mit
• Created: 2023-02-13T18:16:02.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-04-13T22:43:42.000Z (almost 2 years ago)
• Last Synced: 2024-12-06T03:44:46.120Z (about 2 months ago)
• Topics: deployment, jest, react-router, reactjs, single-page-app, unit-testing
• Language: JavaScript
• Homepage:
• Size: 1.14 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# 📗 Table of Contents

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

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

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 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)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 Math Magicians

"Math magicians" 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

- React.js

- VSCode and GitHub

### Tech Stack 

  Client

  


    
React.js

  

  


    
HTML

  

  


    
SASS

  


  Server

  


    
N/A

  


Database

  


    
N/A

  


(back to top)


### Key Features

- **[Git Flow]**

- **[Best practices for JavaScript]**

(back to top)


## Live Demo

[Live Demo Link](https://calculator-webapplication.netlify.app/)

## 💻 Getting Started

Clone this repository to get started with the project, make sure to configure linters by following the instructions in the [Linters README file](https://github.com/microverseinc/linters-config/blob/master/README.md)

### Prerequisites

In order to run this project you need:

- A working computer.

- Connection to internet.

- [npm](https://www.npmjs.com/) and [Node.js](https://nodejs.org/en/) installed, if you don't have them, please follow this [simple installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).

### Setup

- Clone the folder to your local machine.

- Open a local copy of the project in your code editor.

(back to top)


### Usage

- To run the project, execute the following command:

    - npm start in your terminal.

- To run test functions, execute the following command:

    - npm test in your terminal.

(back to top)


### Run tests

- After pushing the changes on github, merge your pull request and let github action process changes and fix errors, if any.

  - For stylelint errors run:sudo npx stylelint "\*_/_.{css,scss}" --fix for automatic fix.

  - For ESLINT errors run:npx eslint "**/*.{js,jsx}" --fix for automatic fix.

(back to top)


## 👥 Authors

👤 **Ashmal Zahra**

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

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

- LinkedIn: [ashmal-zahra](https://www.linkedin.com/in/ashmal-zahra)

(back to top)


## 🔭 Future Features 

- [ ] **Deployment**

(back to top)


## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/ashmalzahra/math-magicians/issues).

(back to top)


## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for the information provided to build this project.

(back to top)


## ❓ FAQ (OPTIONAL) 

- **Can I use the project for any purpose?**

  - Yes, you can.

- **Is the information saved in any database?**

  - No, all data is saved in Local Storage.

(back to top)


## 📝 License

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

(back to top)