Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/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.
https://github.com/mwismann/math-magicians

css jest react reactjs

Last synced: 13 days ago
JSON representation

Host: GitHub
URL: https://github.com/mwismann/math-magicians
Owner: mwismann
License: mit
Created: 2023-03-20T22:26:16.000Z (almost 2 years ago)
Default Branch: dev
Last Pushed: 2023-03-30T15:52:38.000Z (almost 2 years ago)
Last Synced: 2024-11-08T20:53:49.452Z (about 2 months ago)
Topics: css, jest, react, reactjs
Language: JavaScript
Homepage:
Size: 966 KB
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#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](https://api-ninjas.com/) services. Each component is tested with [Jest](https://jestjs.io/) and the [React Testing Library](https://testing-library.com/). The project is deployed using the cloud application hosting service by [Render](https://render.com/).

## 🛠 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](https://math-magicians-6tjd.onrender.com)

(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:

```sh

  cd my-folder

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

```

### Install

To install this project dependencies run the following command:

```sh

  npm install

```

### Usage

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

```sh

  npm start

```

### Run tests

- To test this project run the following command:

```sh

  npm test

```

### Deployment

- This is not a deployable project

(back to top)


## 👥 Authors 

👤 **Mathias Wismann**

- GitHub: [@mwismann](https://github.com/mwismann)

- Twitter: [@mathias_wismann](https://twitter.com/mathias_wismann)

- LinkedIn: [Mathias Wismann](https://www.linkedin.com/in/mathias-wismann/)

👤 **Giancarlo Dumani**

- GitHub: [@gdumani](https://github.com/gdumani)

- Twitter: [@gdumani1](https://twitter.com/gdumani1)

- LinkedIn: [ Giancarlo-Dumani](https://www.linkedin.com/in/gdumani/?originalSubdomain=cr)

(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](../../issues/).

(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](./LICENSE) licensed.

(back to top)