Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/besufekad-haz/math-magicians

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

computer-science math quotes-api

Last synced: 13 days ago
JSON representation

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

Awesome Lists containing this project

README

        



logo

README

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [Screenshot](#screenshot)
- [Loom Presentation Video](#loom-video)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 Math magicians

A website for organizing daily activities

["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.
- Read a random math-related quote.

In this first project of the Math Magicians application. I set up the environment and tools needed to develop a React application.

## 🛠 Built With HTML,CSS and Javascript

### Tech Stack

Client

Server

Database

### Key Features

- **[HTML]**
- **[CSS]**
- **[Javascript]** ---> with ES6
- **[Webpack]**
- **[API's(Notion)]**

(back to top)

## 🚀 Screenshot

![image](https://user-images.githubusercontent.com/23375153/228686248-1ea1a33a-9f96-42d1-9a0f-be55cb6c5a49.png)

## 💻 Loom Presentation Video

- not available yet.

## 🚀 Live Demo

- [Live Demo Link](https://6425ee977d248300b5a7d207--math-magicians-calc-app.netlify.app)

(back to top)

## 💻 Getting Started

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

### Prerequisites

In order to run this project you need:

-A Computer (MAC or PC)
-code editor (VSCode,Atom etc...)
-A browser (Chrome,Mozilla,Safari etc...)
-Version Control System (Git and Github)
-NodeJS (https://nodejs.org/en/)
-React {https://react.dev/}

### Setup

Clone this repository to your desired folder:

cd my-folder
git clone [email protected]:Besufekad-HAZ/Math-Magicians.git (SSH)

### Install

Install this project with:

npx create-react-app my-app
cd my-app
npm start
npm install --save-dev [email protected] [email protected] [email protected] [email protected]
npm install --save-dev [email protected] [email protected] [email protected] [email protected]

### Run tests

To run tests, run the following command:

To check Styelint error:-

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

To check Eslint error:-

npx eslint .

### Deployment

You can deploy this project using:
Github Pages.

(back to top)

## 👥 Authors

👤 **Besufekad Alemu**

- GitHub: [@Besufekad-HAZ](https://github.com/Besufekad-HAZ)
- Twitter: [@BesufekadAlemu7](https://twitter.com/BesufekadAlemu7)
- LinkedIn: [@besura](www.linkedin.com/in/besura)

(back to top)

## 🔭 Future Features

- [ ] **[Adding_full_functionality_to_the_Calculator]**
- [ ] **[Deploying_the_page_on_github]**
- [ ] **[Adding_backend_and_databases]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Besufekad-HAZ/Math-Magicians/issues).

(back to top)

## ⭐️ Show your support

If you like this project rate it and give it a star.

(back to top)

## 🙏 Acknowledgments

--> I would like to thank the Microverse team for allowing us to work on this Math magicians project.

(back to top)

## 📝 License

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

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)