Math Magicians

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 Math Magicians

Math Magicians is a project aimed at enhancing math skills through interactive web applications. With a user-friendly interface, it offers features like a calculator, random math facts, and a dynamic math quote generator. Collaborators can contribute, enhance, and engage in a community focused on promoting mathematical understanding and enjoyment.

🛠 Built With

Tech Stack

• HTML
• CSS
• Javascript
• React.js

Key Features

• Basic configuration of React app
• Linters checking (ESLint, Stylelint)

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Node.js
• npm
• Git
• React.js
• React-Create-App

Setup

Clone this repository to your desired folder:

  cd my-folder

HTTPS:

git clone https://github.com/sergio-usma/math-magicians.git

SSH:

git clone [email protected]:sergio-usma/math-magicians.git

Install

Install this project with:

npm install

Usage

To run the project, execute the following command:

npm start

Run tests

To run tests, run the following command:

npm test

Deployment

You can deploy this project using:

npm run build

(back to top)

👥 Authors

👤 Author

• GitHub: @sergio-usma
• Twitter: @VonUsma
• LinkedIn: Sergio Andres Usma

(back to top)

🔭 Future Features

• Calculator: Perform basic arithmetic operations and get instant results.
• Random Math Facts: Learn interesting and fun math facts with each refresh.
• Math Quote Generator: Get inspired by a new math quote every time you visit.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, please consider supporting us! Your support helps us to continue developing and improving our project for everyone to enjoy. Whether it's a small donation, sharing the project with your friends, or contributing your skills and expertise, every little bit makes a huge difference. With your support, we can create something truly amazing together. Thank you for being a part of our community and helping us to make a difference!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for giving me the opportunity to build this project. I would also like to thank my peers for their feedback and support.

(back to top)

❓ FAQ

A. How do I set up the project?

Clone the repository from GitHub.

HTTPS:

git clone https://github.com/sergio-usma/math-magicians.git

SSH:

git clone [email protected]:sergio-usma/math-magicians.git

B. How can I contribute to the project?

1. Fork the repository. Create a new branch:

git checkout -b feature/branch_name

2. Make your changes and commit them:

git commit -m 'Add new feature'

3. Push to the branch:

git push -u origin feature/branch_name

4. Submit a pull request.

(back to top)

📝 License

This project is MIT licensed.

(back to top)