math_magicians

math_magicians

Desktop Veiw Representation

? 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
• ❓ FAQ (OPTIONAL)
• License

[math_magicians]

[math_magicians] is a website for mathematics fans. It is a Single Page App (SPA) created using React.JS library, that allows users to make simple calculations and read a random math-related quote.

? Built With

Tech Stack

• Client
  • HTML
  • CSS
  • JavaScript
  • ReactJS
  • API

Key Features

• [Responsive layout]
• [UX/UI accessibility]
• [Dynamic data]

(back to top)

Live Demo

• Live Demo on Gh-pages
• Live Demo on Render

(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 browser of you choice.
• A text editor of your choice.
• An installed node.js on your local system

Setup

Clone this repository to your desired folder:

• Use the following Commands:

  cd your-desired-folder
  git clone [email protected]:ab-noori/math_magicians.git
  

Install

• Install this project with:

   npm react-app .
   npm start
  

Usage

• Use following commands to run on your local system:

  npm run build
  npm run deploy
  

Run tests

• Run the following script and style test:

  npx eslint "**/*.{js,jsx}"
  npx eslint "**/*.{js,jsx}" --fix
  
  npx stylelint "**/*.{css,scss}"
  npx stylelint "**/*.{css,scss}" --fix
  

Deployment

• 1- install 'gh-pages' with following command:

  npm i -D gh-pages
  

• 2- Add 'homepage' to project's jason file:

  "homepage": "https://ab-noori.github.oi/math_magicians",
  

• 3- Add the following scripts to project's jason file:

  "predeploy": "npm run build",
  "deploy": "gh-pages -d build "
  

• 4- Finally run the following command:

  npm run deploy
  

(back to top)

Authors

? Abdul Ali Noori

• GitHub: @ab-noori
• Twitter: @AbdulAliNoori4
• LinkedIn: abdul-ali-noori

? Future Features

• [Add About page]
• [Add Contact page]

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

(back to top)

Acknowledgments

I would like to thank Microverse and my coding partners. Also I want to give credit to Nerd's lesson YouTub Channel, it's react tutorial is really helpfull.

(back to top)

❓ FAQ (OPTIONAL)

• How to make it mobile friendly?

  • Put a viewport tag in the header

• How to design the site?

  • Draw a mockup before start to code

(back to top)

License

This project is MIT licensed.

(back to top)