rmiyoyo/math-magicians

"Math Magicians: A React-based SPA for math enthusiasts to perform calculations and discover math-related quotes.

Math Magicians

📗 Table of Contents

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

📖 Meals Project

Math Magicians: A React-based SPA for math enthusiasts to perform calculations and discover math-related quotes..

🛠 Built With

• HTML
• CSS
• ES6
• Webpack
• React
• Jest

Tech Stack

Client

• HTML
• CSS
• ES6
• Webpack
• React

Key Features

• Make simple calculations.
• Read a random math-related quote.

(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:

• A Chrome browser
• Node
• npm

Setup

Clone this repository to your desired folder:

cd my-folder
git clone git@github.com:rmiyoyo/math-magicians.git

Install

Install the prerequisites this project using:

cd math-magicians

npm start

Usage

To run the project:

npm install

Run tests

To run tests after setting up the linters, run the following command:

npx hint .

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

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

Deployment

You can deploy this project using:

• Run index.html on your preferred browser.

(back to top)

👥 Authors

👤 Raphael Miyoyo

• GitHub: Raphael Miyoyo
• Twitter: @r_miyoyo
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Deploy to a live server

(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, create a pull request or hit me up on @r_miyoyo.

(back to top)

🙏 Acknowledgments

I appreciate you for having a look at my project! 💯

(back to top)

📝 License

This project is MIT licensed.

(back to top)