Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mahammad-mostafa/math-magicians
This is the first project of the third module in the Microverse program. It is a single page site with basic calculator tool using ReactJS framework.
https://github.com/mahammad-mostafa/math-magicians
create-react-app es6 jsx microverse microverse-projects microverse-students react react-components react-hooks reactjs responsive-layout single-page-app
Last synced: about 1 month ago
JSON representation
This is the first project of the third module in the Microverse program. It is a single page site with basic calculator tool using ReactJS framework.
- Host: GitHub
- URL: https://github.com/mahammad-mostafa/math-magicians
- Owner: mahammad-mostafa
- License: mit
- Created: 2023-08-08T22:15:19.000Z (over 1 year ago)
- Default Branch: development
- Last Pushed: 2023-09-17T03:07:26.000Z (over 1 year ago)
- Last Synced: 2024-10-19T02:46:15.045Z (3 months ago)
- Topics: create-react-app, es6, jsx, microverse, microverse-projects, microverse-students, react, react-components, react-hooks, reactjs, responsive-layout, single-page-app
- Language: JavaScript
- Homepage: https://math-magicians-8iam.onrender.com
- Size: 1.13 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 🏷️ Math Magicians
This is the first project of the third module in the **Microverse** program.
Check the below contents for further details about this project.
# 📗 Contents
- [Description](#description)
- [Instructions](#instructions)
- [Authors](#authors)
- [Future](#future)
- [Contributions](#contributions)
- [Support](#support)
- [Acknowledgements](#acknowledgements)
- [License](#license)
# 📖 Description
This project is a simple site with calculator tool built with `ReactJS` framework.
It applies `Components` and `Hooks` along with `GitFlow` workflow.
Navigation inside the app is implemented using `React Router`.
Styling inside the project is done with `CSS Modules`.
All project dynamic files are contained in `src` directory while static assets are in `public` directory.
The live build is generated inside the `build` directory.
Unit testing is applied during this project using `Jest` framework.
Also config linters for (`CSS3` / `JavaScript`) in the `.github` folder.
📌 **Live Demo:**
- See the project live from [here](https://math-magicians-8iam.onrender.com).
📌 **Tech Stack:**
- Framework used is `ReactJS`
- Page structure is built with `JSX`
- Styling is built with `CSS3`
- Dynamic content is built with `ES6` JavaScript
- Bundling is done with `WebPack`
- Testing is done with `Jest` framework
📌 **Key Features:**
- Single page app with all content loaded dynamically
- Responsive layout with all screen sizes
- Calculator interface with realtime results
- Display live quotes from an external api
# 🛠️ Instructions
You can easily download or fork this repository and work on it immadiately!
📌 **Prerequisites:**
- `NodeJS` for installing & running all packages
📌 **Installation:**
- Install all dependencies with `npm`
```
npm install
```
📌 **Development:**
- For live development on `localhost:3000` run:
```
npm run start
```
📌 **Testing:**
- To run unit tests use:
```
npm run test
```
📌 **Deployment:**
- You can deploy this project by uploading files in the `build` folder to a live server.
- Create the distribution build using this command:
```
npm run build
```
# 👥 Authors
📌 **Mahammad:**
- [GitHub](https://github.com/mahammad-mostafa)
- [Twitter](https://twitter.com/mahammad_mostfa)
- [LinkedIn](https://linkedin.com/in/mahammad-mostafa)
# 🔭 Future
Some additional features I may implement in the project:
- [ ] Using `CSS` preprocessors and their relevant loaders
- [ ] Implement advanced `Hooks` features for like `useMemo`
# 🤝🏻 Contributions
Wish to contribute to this project?
Contributions, issues, and feature requests are more than welcome!
Feel free to check the [issues](../../issues) page too.
# ⭐️ Support
Like this project? Show your support by starring!
# 🙏🏻 Acknowledgements
I thank everyone at **Microverse** for guiding me through this project.
# 📝 License
This project is [MIT](LICENSE.md) licensed.