Code Monkey home page Code Monkey logo

math-magicians's Introduction

๐Ÿ“— Table of Contents

๐Ÿ“– 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.
  • Read a random math-related quote.

๐Ÿ›  Tech Stack

  • HTML
  • CSS
  • JavaScript
  • Webpack
  • React
  • Linters

Key Features

  • Setup react app
  • Configure linter
  • Add Components.
  • Add Events.

(back to top)

๐Ÿš€ Live Demo

Live Demo Link

(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:

  • GIT
    • if you don't have git installed on your machine you can download it from here.
  • Linter
    • You can get install guide from here
  • Node.js & Npm
    • if you don't have npm installed on your machine you can download it from here

Setup

Once you have git installed on your machine you can clone project by running the command below. To clone your project to your local machine

  git clone https://github.com/dev-mamun/math-magicians.git

Alternatively, you can download the zip file of your project by clicking on the Code button on the right side of your project page and clicking on Download ZIP

Install

Install this project with:

  cd math-magicians
  npm install
  npm run build

Usage

To run the project, use the following : (Port 3000)

  npm start
  Runs the app in the development mode.\
  Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

(back to top)

Run tests

To run tests, run the following command:

   npm run test

To check for css errors run:

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

To check for js errors run:

  npx eslint .

๐Ÿ‘ฅ Author

๐Ÿ‘ค Abdullah AL mamun

๐Ÿ”ญ Future Features

  • Add Style.
  • add the logic needed to make the Calculator component work

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

โญ๏ธ Show your support

Give a โญ๏ธ if you like this project!

If you like this project feel comfortable to endorse the author. You can contact the author via Twitter or Linkedin or directly message at [email protected]

(back to top)

Available Scripts

In the project directory, you can run:

  • npm start - To run the app in the development mode.
  • npm test - To launch the test runner in the interactive watch mode.
  • npm run buid - To build the app for production to the build folder.Learn more at deployment
  • npm run eject - To remove the single build dependency from your project. Note this is a one-way operation. Once you eject, you can't go back!

โ“ FAQ

-Why use linters?

  • The use of linters helps to diagnose and fix technical issues, also linters can help teams achieve a more readable and consistent style, through the enforcement of its rules.

-Why use modular programming?

  • Modular programming usually makes your code easier to read because it means separating it into functions that each only deal with one aspect of the overall functionality.

-Why use OOP?

  • With this type of programming, a program comprises objects that can interact with the user, other objects, or other programs. This makes programs more efficient and easier to understand.

(back to top)

๐Ÿ“ License

This project is MIT licensed.

(back to top)

math-magicians's People

Contributors

dev-mamun avatar tshobohwa avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.