Ferizad/React-magician

React-magician

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 React-magician

React-magician, is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to: Make simple calculations. Read a random math-related quote.

🛠 Built With

-React

Tech Stack

React | GIT

🚀 Live Demo

• Live Demo is not available

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• A text editor (preferably Visual Studio Code)
• Github

Setup

Clone this repository to your desired folder:

cd my-folder git clone https://github.com/Ferizad/React-magician.git

Install

Install this project with:

• Git
• Node

Usage

To run the project, execute the following command:

• After Cloning this repo to your local machine

  npm start

Run tests

Track HTML linter errors run:

npx hint .

Track CSS linter errors run:

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

Track JavaScript linter errors run:

npx eslint .

Deployment

You can deploy this project using: GitHub pages

(back to top)

👥 Authors

👤 Ferizad

• GitHub: @Ferizad
• Twitter: @FerizadK
• LinkedIn: Ferizad Kanafina

👥 Authors

🔭 Future Features

• [Components ]
• [Events ]
• [Fetch data from API.]
• [Full website.]
• [Tests ]
• [Deploy. ]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project feel free to leave comments and contact via given authors information above.

(back to top)

🙏 Acknowledgments

I would like to thank the code reviewers for the taking time to do the work. A special thank you as well to my teammates for their support it wouldnt have been possible without you guys.

(back to top)

📝 License

This project is MIT licensed.

(back to top)