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

https://github.com/alejandroq12/math-fans

"Math fans" 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. By building this application, I learned how to use React.
https://github.com/alejandroq12/math-fans

css html javascript props react reactjs state

Last synced: 5 days ago
JSON representation

"Math fans" 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. By building this application, I learned how to use React.

Awesome Lists containing this project

README

        

# math-fans


logo


Math Fans

# πŸ“— Table of Contents

- [math-fans](#math-fans)
- [πŸ“— Table of Contents](#-table-of-contents)
- [πŸ“–Math Fans ](#math-fans-)
- [πŸ›  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-)
- [πŸ‘₯ Author ](#-author-)
- [πŸ”­ Future Features ](#-future-features-)
- [🀝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [πŸ™ Acknowledgments ](#-acknowledgments-)
- [❓ FAQ ](#-faq-)
- [πŸ“ License ](#-license-)

# πŸ“–Math Fans

"Math Fans" 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. By building this application, I will learn how to use React.

## πŸ›  Built With
HTML,
CSS,
JavaScript,
React.js

### Tech Stack

Client

Package Manager

Linters

### Key Features

- **Make simple calculations.**
- **Read a random math-related quote.**
- **Fetch data from API.**

(back to top)

## πŸš€ Live Demo

- [Live Demo Link Netlify](https://warm-nasturtium-2364c6.netlify.app/)
-
- [Live Demo Link Render](https://math-fans.onrender.com)

(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 web browser to view output e.g [Google Chrome](https://www.google.com/chrome/).
- An IDE e.g [Visual studio code](https://code.visualstudio.com/).
- `node` should be installed in your local machine, [node website](https://nodejs.org/en/download/).
- Install the `npm` package manager use this [to install both node and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
- [A terminal](https://code.visualstudio.com/docs/terminal/basics).

### Setup

Clone this repository to your desired folder or download the Zip folder:

```
https://github.com/Alejandroq12/math-fans.git
```

- Navigate to the location of the folder in your machine:

**``you@your-Pc-name:~$ cd math-fans``**

### Install

To install all dependencies, run:

```
npm install
```

### Usage

To run the project, follow these instructions:

- After Cloning this repo to your local machine.
- You can also use `npm start` command in terminal to run this at the localhost.

### Run tests

To run tests, run the following command:

- Track CSS linter errors run:
```
npx stylelint "**/*.{css,scss}"
```
- Track JavaScript linter errors run:
```
npx eslint "**/*.{js,jsx}"
```

### Deployment

You can deploy this project using: Render or Netlify,
- I used Netlify and Render to deploy my website.
- For more information about publishing sources, see "[Netlify](https://app.netlify.com/)" or "[Render](https://render.com/)".

(back to top)

## πŸ‘₯ Author

πŸ‘€ **Julio Quezada**

- GitHub: [Alejandroq12](https://github.com/Alejandroq12)
- Twitter: [@JulioAle54](https://twitter.com/JulioAle54)
- LinkedIn: [Julio Quezada](https://www.linkedin.com/in/quezadajulio/)

(back to top)

## πŸ”­ Future Features

- [x] **I will create a responsive website.**
- [ ] **i will add more pages.**

(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 give me a star ⭐️

(back to top)

## πŸ™ Acknowledgments

I want to thank all my colleagues that share knowledge with and inspired to to improve each day.

(back to top)

## ❓ FAQ

- **Did you created this project from zero?**

- Of course, as if it were a real life job scenario.

(back to top)

## πŸ“ License

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

(back to top)