atok624/maths_magicians

"Math magicians" is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to: Make simple calculations. Read a random math-related quote.

Maths 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
• 📝 License

📖 Maths Magician

Maths Magician

• "Math magicians" is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to: Make simple calculations. Read a random math-related quote.

🛠 Built With

• Major Languages: JavaScript.
• Libraries: React,
• Technologies used:

- create-react-app tool
- Git version control
- ESLint code linting
- StyleLint code linting
- Prettier code formatting
- Babel transpiling
- Webpack bundling
- netlify deployment

Tech Stack

HTML
CSS
JAVASCRIPT
BOOTSTRAP

Key Features

Future Features

• API Functionality
• Events

🚀 Live Demo

Live Demo

(back to top)

Access the the online version of my application with this link

(back to top)

💻 Getting Started

To get a local copy up and running, follow the steps in Setup below.

Prerequisites

Basic knowledge of:
- HTML
- CSS
- JavaScript
- React.

Setup

If you have git installed, you can clone the code to your machine, or download a ZIP of all the files directly.

Download the ZIP from this location, or run the following git command to clone the files to your machine:

  cd my-folder
  git clone [email protected]:atok624/maths-magician.git

(back to top)

Usage

Run in development mode (Port 3000)

  npm run start

Build for production

npm run build

Run tests

To run tests, run the following command:

   npm test

Linter Tests

• To check for html errors run:

  npx hint .

• To check for css errors run:

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

• To check for js errors run:

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

👥 Author

👤Nicholas Kwamena Amissah

• GitHub: Nicholas Amissah
• Twitter: Nicholas Amissah
• LinkedIn: Nicholas Amissah

(back to top)

(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 give it a star on the main page

(back to top)

🙏 Acknowledgments

I would like to thank the following :

• Microverse
• All the Patners I've had for Module.

(back to top)

📝 License

This project is MIT licensed.

(back to top)