DjibrilM / math-magician

🧮 math-magicians

📖 Table of Contents

• About the Project
  • 🛠️ Built With
    • Tech Stack
    • 🔑 Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Run Tests
    • Build
    • Webpack Development Server
  • 👤 Author
  • 🔮 Future Features
  • 🤝 Contributing
  • ⭐️ Show Your Support
  • 🙏 Acknowledgments
  • 📝 License

📖 About the Project

math-magicians is a web application designed for mathematics enthusiasts. It is a Single Page App (SPA) that provides users with the ability to perform simple calculations and discover random math-related quotes.

The purpose of the project is to create an intuitive and user-friendly calculator application that allows users to perform basic calculations on any device with an internet connection. Additionally, the application provides inspirational and thought-provoking math-related quotes to inspire users.

🛠️ Built With

Tech Stack

🖥️ Client

• React
• CSS
• HTML

🔑 Key Features

• ✨ Simple Calculations: Users can make basic calculations such as addition, subtraction, multiplication, and division. The application provides an intuitive user interface where users can input numbers and operators to perform the desired calculations.

• 🏅 Random Math Quotes: The application offers a collection of inspirational and thought-provoking math-related quotes. Users can read a randomly generated quote by simply refreshing the page or clicking a dedicated button.

(back to top)

🚀 Live Demo

• 🔗 Live Demo Link

(back to top)

💻 Getting Started

Prerequisites

To run this project, you need the following:

• 🌐 Web browser
• 🐙 Git
• 👨‍💻 Code editor

Setup

Clone this repository to your desired folder:

git clone https://github.com/kit0-0/math-magicians.git

Install

To install all dependencies, run the following command:

npm install

Run Tests

To run tests, use the following commands:

• To track CSS linter errors, run:

npx stylelint "**/*.{css,scss}"

• To track JavaScript linter errors, run:

npx eslint "**/*.{js,jsx}"

Build

To build the project, run the following command:

npm run build

Webpack Development Server

To run the webpack development server, execute the following command:

npm start

(back to top)

👥 Authors

• GitHub: @DjibrilMugisho
• Twitter: @djibrilM
• LinkedIn: DjibrilMugisho

(back to top)

🔮 Future Features

• 📱 Add Animation: Enhance the user interface with smooth animations and transitions to make the user experience more engaging and interactive.

• 📝 Add Model: Implement a mathematical model or algorithm to perform advanced calculations, such as trigonometric functions or logarithms, providing users with a wider range of mathematical operations.

• styling

• calculator

• testing

(back to top)

🤝 Contributing

Contributions to Math Magicians are welcome! If you would like to contribute, please follow these guidelines:

1. Fork the repository and create a new branch for your contribution.
2. Make your changes and ensure that the code is properly formatted.
3. Write clear and concise commit messages.
4. Push your branch to your forked repository.
5. Submit a pull request detailing the changes you've made.

Feel free to check the issues page.

(back to top)

⭐️ Show Your Support

If you like this project, give it a ⭐️.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for providing guidance and support during the development of this project.

(back to top)

📝 License

This project is licensed under the MIT License.

(back to top)