rudicarrilloypr/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.

Math Magicians

📗 Table of Contents

• 📖 Math Magicians
• 🛠 Built With
  • Tech Stack
  • Key Features
• 🚀 Live Demo
  • 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔮 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Math 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.

🛠 Built With

• React APP

Tech Stack

Client

• JavaScript

Server

• Local Storage

Database

• JavaScript

Key Features

• Use of React to setup de project.
• Recieve API quotes into Quote section.

(back to top)

🚀 Live Demo

Click here to see the project's deployment.

(back to top)

💻 Getting Started

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

Prerequisites

Before you proceed, ensure that you have the following installed on your machine:

• Node.js (v12 or above)
• npm (Node Package Manager)

Setup

Clone this repository to your desired folder:

  git clone git@github.com:rudicarrilloypr/math-magicians.git

Install

Install the project dependencies with:

  npm install

Usage

To run the project, execute the following command:

  npm run build

Run tests

To run tests, run the following command:

  npm start

• Open your web browser and visit http://localhost:8080.
• You should now see the Math Magicians application running in your browser.

(back to top)

👥 Authors

👤 Rudi Carrillo

• GitHub: @rudicarrilloypr
• Twitter: @__rudicarrillo
• LinkedIn: Rudi Carrillo
• Instagram: @__rudicarrillo

(back to top)

🔮 Future Features

• style updates
• tests

(back to top)

🤝 Contributing

Contributions are welcome! If you find any bugs or want to enhance the project with new features, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make the necessary changes and commit them.
4. Push your changes to your forked repository.
5. Submit a pull request describing your changes.

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)

❓ FAQ

• How do I set up the project?

  • Clone the repository from GitHub, and see the Setup section above for details.

• How can I contribute to the project?

  1. Fork the repository on GitHub.
  2. Create a new branch for your changes using git checkout -b my-feature-branch.
  3. Make your changes and commit them with descriptive commit messages.
  4. Push your changes to your forked repository.
  5. Submit a pull request to the original repository.
  6. Wait for feedback and iterate on your changes as needed.

(back to top)

📝 License

This project is MIT licensed.

(back to top)