Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sonickmumba/math-magicians
"Math magicians" is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to make simple calculations and read a random math-related quote. It is built using React.
https://github.com/sonickmumba/math-magicians
css gitflow html javascript jest react webpack
Last synced: 23 days ago
JSON representation
"Math magicians" is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to make simple calculations and read a random math-related quote. It is built using React.
- Host: GitHub
- URL: https://github.com/sonickmumba/math-magicians
- Owner: Sonickmumba
- Created: 2022-09-19T14:01:49.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-05-11T14:37:34.000Z (over 1 year ago)
- Last Synced: 2024-10-31T02:41:55.504Z (2 months ago)
- Topics: css, gitflow, html, javascript, jest, react, webpack
- Language: JavaScript
- Homepage:
- Size: 1.02 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Math Magicians
> "Math magicians" is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to make simple calculations and read a random math-related quote. It is built using React.
## Built With ⚙️
- **Major languages**: HTML, CSS, & JavaScript.
- **Frameworks**: No-Frameworks.
- **Linters**: Lighthouse, Webhint, Stylelint and ESLint.
- **Technologies used**: NPM, Webpack, & Jest Library, API.
- **Tools**: Git, Gitflow, GitHub, VS Code, & Chrome Browser.
## Live Demo (Deployed on GitHub Pages with SSL)
[Live Demo Link](https://dancing-conkies-c08f95.netlify.app)
## Video Presentation
[Live Video Link]()
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
- [x] Basic knowledge of **React**.
- [x] Basic Knowledge of **HTML**, **CSS**, & **JavaScript**.
- [x] Basic knowledge of **ES6** syntax.
- [x] Basic knowledge of **Git**, **GitHub** &**Gitflow**.
- [x] Basic knowledge of **Linters**.
- [x] Basic knowledge of **Webpack**.
- [x] Basic knowledge of **Jest** unit-testing library.
- [x] Basic knowledge of **VS Code** or any other code-editors.
### Setup
- Create a new **Microverse** folder and move into it.
- Open the **Command Prompt (CMD)** in the current directory (Microverse Folder).
- Run the following command:
```
$ git clone [email protected]:Sonickmumba/Math-Magicians.git
```
- Once finished you should see a new folder called **Math Magicians** in your current directory.
- Start customizing the project so it fits your personal preferences and needs.
- Enjoy your new professional **Math Magicians Web** application!
### Run tests
To check for linters, use the files provided by [Microverse](https://github.com/microverseinc/linters-config). A GitHub action is also set to run during pull request.
```
$ npm install
```
### Deployment
For deployment you can use the **[GitHub Pages](https://pages.github.com/)**.
## Authors
👤 **Sonick Mumba ([Sonickmumba](https://github.com/Sonickmumba))**
- GitHub: [Sonickmumba](https://github.com/Sonickmumba)
- Twitter: [@Sonick](https://twitter.com/MumbaSonick)
- LinkedIn: [Sonick Mumba](https://www.linkedin.com/in/sonick-m-301557a2/)
## Show your support
Give a ⭐️ if you like this project!
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## Acknowledgments
- [Microverse](https://www.microverse.org/)
- Code Reviewers & Coding Partners
- etc
## 📝 License
This project is [MIT](./LICENSE) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._