Math Magicians

📗 Table of Contents

• � Table of Contents
• 📖 Math Magicians
• 🛠 Built With
  • Tech Stack
  • Key Features
• 🚀 Live Demo

• 💻 Getting Started
  • Prerequisites
  • Setup
  • Usage
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgments
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Math Magicians Project

Math Magicians Project is a Single Page App (SPA) that has 3 sections:

1. A homepage that welcomes the user and explains a bit about the website
2. A calculator section that provides a simple 4 basic math operations
3. A quotes section that displays a random quote which is called from an external API The project is implemented using Javascript ES6 and React. It uses 'API-Ninjas' for API calls.

🛠 Built With

Tech Stack

Technology

• HTML
• CSS
• Javascript

Tools

• VSCode
• Git
• node
• npm
• React
• webpack
• jest

Key Features

• Provides a Calculator
• Displays a Random quote for each day

(back to top)

🚀 Live Demo

• An implementation of this portfolio is live on Github Pages (to be updated)

(back to top)

💻 Getting Started

Prerequisites

In order to reproduce the Math-Magicians and be able to make changes for your own purpose you need the following tools:

• Visual Studio Code
• git-scm
• A Github account
• NodeJS (which also includes npm package manager)

Setup

1. Make a new directory and go inside the directory using cd command in terminal
2. Use "git" to clone this repository into your local drive:

   $ git clone https://github.com/dev89s/math-magicians.git

3. Run the command to install all necessary dependancies:

   npm install

Usage

• Feel free to experiment with the project.
• To build the project:

  npm run build

• The index.html file in dist folder is the output file that you want to open in the browser.
• To add tests or examine different tests that are alreadt available go to:

  [root_dir]/src/modules/[modulename].test.js

Deployment

You can deploy this project by opening a new github repo and initialize the local git repo and connect it through: $ git remote add origin main [your github repo link] command. Then you can push the project into that repository and if you go to the repository in your account, you'll see the code in the account.

(back to top)

👥 Authors

👤 Sasan Moshirabadi

• GitHub: @dev89s
• LinkedIn: @sasan-moshirabadi-30a77025a

(back to top)

🔭 Future Features

• Updated design with some styling: the desgin will improve.
• Mobile Version: mobile design will be implemented.

(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 consider giving a star to the project and if you want to go furthur make a donation to any one the top 8 charities in Hawaii islands at the link below:

• Hawaii Donation

(back to top)

🙏 Acknowledgments

I would like to thank Microverse online web development school for providing the material and guidance that helped me created this app.

(back to top)

❓ FAQ (OPTIONAL)

• Is mobile first web design a necessity these days?

  • Since 2014 mobile web users have surpassed desktop users and the rate of the new users being introduced to web by mobile devices will only increase by time.

• Does the project support all platforms?

  • Yes! Since it is based on web technology, any device that has a web browser will be able to see the website once it is online.

(back to top)

📝 License

This project is MIT licensed.

(back to top)