Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/masumajaffery/math-magicians
https://github.com/masumajaffery/math-magicians
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/masumajaffery/math-magicians
- Owner: MasumaJaffery
- Created: 2023-07-11T11:33:35.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-07-22T22:26:19.000Z (over 1 year ago)
- Last Synced: 2024-10-27T18:43:02.751Z (about 2 months ago)
- Language: JavaScript
- Size: 1.52 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Math Magicians
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [Math Magicians WebApp](#math-magicians-webapp)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Testing](#testing)
- [Build](#build)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
**Math Magicians**
Client
- **Use of semantic HTML**
- **SPA Approach**
- **React Library**
To get a local copy up and running, follow these steps.
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder-name
git clone [email protected]:NitBravoA92/math-magicians.git
```
### Prerequisites
In order to install, modify and run this project, it is necessary to have the following applications installed:
- **Git:** to manage the project versions of source code. [You can Download Git here](https://git-scm.com/)
- **Nodejs and NPM:** to install and manage the project dependencies. [Nodejs and NPM installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- **A code editor** like Visual Studio Code (Recommended) or any other of your preference. It is necessary to open the project and add or modify the source code. [You can Download Visual Studio Code here](https://code.visualstudio.com/)
It is also important to have at least basic knowledge about ReactJS, JSX, HTML, CSS and Javascript languages so you will be able to understand and work with the code of the project.
- [Learn the basics of HTML](https://developer.mozilla.org/en-US/docs/Web/HTML)
- [Learn the basics of CSS](https://developer.mozilla.org/en-US/docs/Web/CSS)
- [JavaScript basics](https://developer.mozilla.org/en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics)
- [Javascript Arrays](https://developer.mozilla.org/es/docs/Web/JavaScript/Reference/Global_Objects/Array)
- [Javascript Objects](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
- [JavaScript modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules)
- [ReactJS](https://react.dev/learn)
- [JSX](https://react.dev/learn/writing-markup-with-jsx)
- [Create React App](https://github.com/facebook/create-react-app)
### Install
Install this project by running the next command into your project folder:
```sh
npm install
```
All the packages and libraries necessary for the project to work will be installed in a folder called /node_module. After this installation, the project will be ready to use.
### Usage
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 CSS and JS linters errors in the console running the following commands:
CSS Linter
```sh
npx stylelint "**/*.{css,scss}"
```
Javascript Linter
```sh
npx eslint "**/*.{js,jsx}"
```
### Testing
To test the `App` Component, you can run the following command in the project directory:
- `npm test`
Launches the test runner in the interactive watch mode.\
See more about these tests: [running tests](https://facebook.github.io/create-react-app/docs/running-tests)
### Build
- `npm run build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
**Note**: Please only modify the components files like App.js, testing files like App.test.js and the CSS files. Do not modify configurations files of the project.
## Live Demo:
Open [https://eclectic-kulfi-5d875a.netlify.app/) to view it in your browser.
👤 **Syeda Masuma Fatima**
- GitHub: [@MasumaJaffery](https://github.com/MasumaJaffery)
- Twitter: [@MasumaJaffery](https://twitter.com/MasumaJaffery)
- LinkedIn: [Masuma Jaffery](https://www.linkedin.com/in/masuma-jaffery-797a29256/)
## 🔭 Future Features
- [ ] **UI of the Calculator**
- [ ] **React Functionalities**
- [ ] **Add Features**
Contributions, issues, suggestions and feature requests are welcome!
If you liked this project, Please Starred my repo's.
Special Thanks to Microverse and Microanuts.
This project is [MIT](./MIT.md) licensed.