https://github.com/errytagedesign/math-magician

https://github.com/errytagedesign/math-magician

Last synced: 19 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/errytagedesign/math-magician
• Owner: Errytagedesign
• Created: 2023-08-09T15:53:23.000Z (over 1 year ago)
• Default Branch: dev
• Last Pushed: 2023-08-18T07:22:37.000Z (over 1 year ago)
• Last Synced: 2024-10-27T21:21:19.322Z (2 months ago)
• Language: JavaScript
• Size: 1.07 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  
Math Magician Projects


# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run Linters](#run-linters)

  - [Deployment](#deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 A Math Magician Projects create with React 

A Math Magician Projects developed with React, gitflow, and githubflow. In addition, i added Linters for Css and Javascript.

## 🛠 Built With 

1-Reactjs

2-Css

3-Js

### Tech Stack 

  Client

  


    
REACT

    
CSS

    
JS

  


### Key Features 

- Initial setup with CRA.

- Add Linters.

(back to top)


## 💻 Getting Started 

### Prerequisites

1-Web Browser

2-Code Editor

3-Git

### Setup

Clone this repository to your desired folder:

Run this Command:

```sh

  cd my-folder

  git clone https://github.com/Errytagedesign/mathMagician

```

### Install

First you need to install the node package files

Run this command:

```sh

  cd mathMagician

  npm install

```

### Usage

- In order to use this project you either create branch to add more features.

- But in order to run the project run npm start

- Run npm run build when you're done.

### Run Linters

I have added the linters or tests in order to avoid anykind of typos and ensure the good practices in this project. So while using this repository if you need to check your work in html and css you can use below commands

- in order to run the linter test on index.html:

```sh

  npx eslint "**/*.{js,jsx}"

```

- in order to run the linter test on stylesheets:

```sh

 npx styleint "**/*.{css,scss}"

```

### Deployment

- You can easily use github pages, netlify or vercel to deploy your project

  Useful link about Github Pages

  Step by Step guide to deploy using netlify

  Step by Step guide to deploy using vercel

(back to top)


## 👥 Authors 

👤 Sodeeq Awoyemi

- GitHub: [@githubhandle](https://github.com/Errytagedesign)

- Twitter: [@twitterhandle](https://twitter.com/errytage)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/errytagedesigns/)

(back to top)


## 🔭 Future Features 

- [ ] Create components dir

- [ ] Create file into the components dir

- [ ] Create math Magician projects

- [ ] Hit The API

(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 just give it a star -

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse.

(back to top)


## 📝 License 

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

(back to top)