forLoop94/Math-magicians

Math Magicians

📗 Table of Contents

• 📗 Table of Contents
• 📖 About
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 About

Math magicians is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to make simple calculations and read random math-related quotes. This application will be built using React.

🛠 Built With

Tech Stack

• HTML
• CSS
• Javascript
• React

Key Features

• Perform all math functions
• Show random math-related quotes

(back to top)

🚀 Live Demo

• live demo

(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 browser
• git
• nodejs

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:forLoop94/Math-magicians.git
  npm install

Usage

To run the project, execute the following command:

  Open index.html in browser
  or
  open with Live server in Vscode

Run tests

To run tests, run the following commands:

  npx stylelint "**/*.{css,scss}"
  npx npx eslint "**/*.{js,jsx}"
  npm test

(back to top)

👥 Author

👤 Charles Andrews

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Fetching data from API

(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 give me a follow and/or a star

(back to top)

🙏 Acknowledgments

My coding partners

(back to top)

📝 License

This project is MIT licensed.

(back to top)