mwismann/math-magicians

SPA created with React, consisting of three pages: Home, Calculator, and Quote. React Routing provides navlinks to navigate the site. Quotes are fetched from an API. Functions are tested with Jest and React Testing Library.

📗 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

📖 [math-magicians]

[math-magicians] is a project where I created a SPA with React. The web app consist of three pages, the Home, Calculator, and Quote. Using the React Routing services, users can interact with the site by clicking on the nav linking provided in the Header to render each page. On Home there is a placeholder text presented as the About content. On Calculator users are able to interact with the app to complete math equations. Lastly, on Quote user's are provided with a random quote fetch from the API Ninjas services. Each component is tested with Jest and the React Testing Library. The project is deployed using the cloud application hosting service by Render.

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• JavaScript
• React

Server

• Render

Database

• API Ninjas

Key Features

• [Correct set up of React environment]
• [Dynamic, functional calculator]
• [Correct fetching of API's data]
• [Testing with Jest and React Testing Library]
• [Deployment with Render]

(back to top)

🚀 Live Demo

• Math Magicians

(back to top)

💻 Getting Started

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

Prerequisites

• You don't need any previous installation in order to run this project

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/mwismann/math-magician.git

Install

To install this project dependencies run the following command:

  npm install

Usage

• To start this project on your localhost run the following command:

  npm start

Run tests

• To test this project run the following command:

  npm test

Deployment

• This is not a deployable project

(back to top)

👥 Authors

👤 Mathias Wismann

• GitHub: @mwismann
• Twitter: @mathias_wismann
• LinkedIn: Mathias Wismann

👤 Giancarlo Dumani

• GitHub: @gdumani
• Twitter: @gdumani1
• LinkedIn: Giancarlo-Dumani

(back to top)

🔭 Future Features

• [Mobile version]

(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 it would be a great help if you could star this repo!

(back to top)

🙏 Acknowledgments

I would like to thank to Microverse for providing me the opportunity and inspiration for this work.

(back to top)

📝 License

This project is MIT licensed.

(back to top)