Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/elijahdre/math-magic

Microverse Module 03 Project: "Math Magicians" is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to make a simple calculations and read a random math-related quote. Built with React, Css and JavaScript.
https://github.com/elijahdre/math-magic

babel calculator css html html-css-javascript javascript microverse microverse-projects microverse-students react webpack5

Last synced: 17 days ago
JSON representation

Microverse Module 03 Project: "Math Magicians" is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to make a simple calculations and read a random math-related quote. Built with React, Css and JavaScript.

Awesome Lists containing this project

README

        

![](https://img.shields.io/badge/Microverse-blueviolet)

# Math Magicians

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

## Built With

- [x] Languages: HTML, CSS and JavaScript
- [x] Linters: Stylelint and ESLint
- [x] Front-end library: React
- [x] Code Editor: VS Code

## Website Mockup 📱 💻 🖥️
![math-magic](https://user-images.githubusercontent.com/47558964/212529494-7bcbe9f8-a65f-4823-b1d8-1ecdfb462f01.PNG)

## Live Demo 🔗

Check the live demo [netlify]()👈

## Getting Started

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

### Prerequisites

- [x] A web browser like Google Chrome.
- [x] A code editor like Visual Studio Code with Git and Node.js.

You can check if Git is installed by running the following command in the terminal.
```
$ git --version
```

Likewise for Node.js and npm for package installation.
```
$ node --version && npm --version
```

### Setup

Clone the repository using the GitHub link provided below.

### Install

In the terminal, go to your file directory and run this command.

```
$ git clone [email protected]:Elijahdre/math-magic.git
```

### Usage

Kindly modify the files as needed.

In the project directory, you can run:
```
$ npm start
```
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
You may also see any lint errors in the console.

### Run tests

To check for linters, use the files provided by [Microverse](https://github.com/microverseinc/linters-config). A GitHub action is also set to run during pull request.
```
$ npm install
```

### Deployment

This app is deployed in the GitHub Pages for easy viewing upon merged on the main branch.
Please find the link in the Live Demo section.

## Author

👤 **Elijah Odjegba**

- GitHub: [![GitHub Badge](https://img.shields.io/badge/-Elijahdre-white?logo=GitHub&logoColor=181717&style=plastic)](https://github.com/Elijahdre)
- Twitter: [![Twitter Badge](https://img.shields.io/badge/-kingglijah-white?logo=Twitter&logoColor=1DA1F2&style=plastic)](https://twitter.com/kingglijah)
- LinkedIn: [![LinkedIn Badge](https://img.shields.io/badge/-Elijah--Odjegba-white?logo=LinkedIn&logoColor=0A66C2&style=plastic)](https://www.linkedin.com/in/elijah-odjegba-862708179/)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Elijahdre/math-magic/issues).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

- [Microverse](https://www.microverse.org/)
- Code Reviewers
- Coding Partner

## 📝 License

This project is [MIT](./MIT.md) licensed.