https://github.com/mohamedsabry0/math-crafters
https://github.com/mohamedsabry0/math-crafters
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mohamedsabry0/math-crafters
- Owner: mohamedSabry0
- Created: 2023-04-26T14:06:39.000Z (about 2 years ago)
- Default Branch: development
- Last Pushed: 2023-05-06T22:42:16.000Z (about 2 years ago)
- Last Synced: 2025-01-13T01:25:49.892Z (5 months ago)
- Language: JavaScript
- Size: 662 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Math Crafters
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 Math Crafters ](#-math-crafters-)
- [Screenshot ](#screenshot-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [not yet deployed](#not-yet-deployed)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [`npm start`](#npm-start)
- [Run tests](#run-tests)
- [`npm test`](#npm-test)
- [👥 Author ](#-author-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [Acknowledgements ](#acknowledgements-)
- [📝 License ](#-license-)
**Math Crafters** is a simple calculator built with React.js
Client
- **[Simple calculator functionality]**
- **[Uses React Router to comply with user experience while being a single page application]**
#### not yet deployed
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Node
- npm
Probably with versions:
- Node >= 19.6.0
- npm >= 9.4.0
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone [email protected]:mohamedSabry0/math-crafters.git
```
### Install
Install this project with:
```sh
cd math-crafters
npm i
```
### Usage
To run the project, execute the following command:
#### `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 run tests, run the following command:
#### `npm test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
👤 **Mohamed Sabry**
- GitHub: [@mohamedSabry0](https://github.com/mohamedSabry0)
- Twitter: [@mohsmh0](https://twitter.com/mohsmh0)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/mohamed-sabry0/)
- [ ] **[Add more complex calculations]**
- [ ] **[Add unit and integration tests]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/mohamedSabry0/math-crafters/issues).
If you like this project it would be truly appreciated if you give it a ⭐️.
> We seek knowledge from the cradle to the grave.
I am grateful for these resources as they were a reason that I obtained a glimpse of their abundance of knowledge:
- [Microverse](https://www.microverse.org/)
- [ReactJS Docs](https://reactjs.org/docs)
- [React Router Docs](https://reactrouter.com/en/main)
- I also thank other resources that might have slipped from my mind to mention, I really appreciate all the efforts in delivering helpful resources of knowledge.
This project is [MIT](./MIT.md) licensed.