Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/hajnaloltyan/react-calculator

A React Calculator App with a Daily Quotes page, and About page. Using React and React Router with CSS to create it.
https://github.com/hajnaloltyan/react-calculator

css3 react react-router

Last synced: 3 days ago
JSON representation

A React Calculator App with a Daily Quotes page, and About page. Using React and React Router with CSS to create it.

Awesome Lists containing this project

README

        


logo

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 Math Magicians ](#-math-magicians-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Math Magicians

This is my Microverse **Math Magicians** site, created with React and CSS.

## 🛠 Built With

### Tech Stack

React

CSS

GitFlow

### Key Features

- **React**
- **GitFlow**

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://hajnaloltyan.github.io/react-calculator)

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

- Code editor
- Node
- Registered account at the following external API: [API NINJAS](https://api-ninjas.com/api/quotes)

### Setup

Clone this repository to your desired folder by opening the terminal and running the following command:

```sh
git clone [email protected]:hajnaloltyan/react-calculator.git

```

### Install

Install this project with:

```sh
npm install

```

### Usage

Create in the project's root directory a **.env** file without installing any additional dependency.

Inside that file add your own API key with the following format:

```sh
REACT_APP_API_KEY='your API key'

```

To run the project use the following command:

```sh
npm start

```

### Run tests

To run tests, run the following commands:

For CSS linter errors:

```sh
npx stylelint "**/*.{css,scss}"

```

For ESLint linter errors:

```sh
npx eslint "**/*.{js,jsx}"

```

### Deployment

Deployed by GitHub Pages.

```sh
npx run deploy

```

(back to top)

## 👥 Authors

👤 **Hajnalka Oltyan**

- GitHub: [@hajnaloltyan](https://github.com/hajnaloltyan)
- LinkedIn: [Hajnal Oltyan]](https://www.linkedin.com/in/hajnalka-oltyan/)

(back to top)

## 🔭 Future Features

- Add more operation buttons to the Calculator

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

(back to top)

## ⭐️ Show your support

If you like this project please leave a star and a comment.

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse to have this opportunity, and also thank you the code review team.

(back to top)

## 📝 License

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

(back to top)