math-magicians

📗 Table of Contents

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

📖 math-magician

math-magicians is a website for all fans of mathematics. It is a Single Page Application(SPA) that allows users to make simple calculations and read a random math-related quote.

🛠 Built With

• HTML
• CSS
• React.js
• JavaScript

Getting Start

This project was bootstrapped with Create React App.

• Clone the repository by running
  git clone https://github.com/Enoisong/math-magicians.git
• navigate to the folder
  cd math-magicians
• Install packages
  npm install
• Run the app
  npm start
• Eject the app
  npm run eject
• Create build app
  npm run build
• Test Linters app
  npm run check-linters

Tech Stack

• React
• Gitflow
• Version Control (GitHub)

Key Features

• React & Redux linters added
• Use Gitflow

(back to top)

💻 Getting Started

clone from repository: https://github.com/Enoisong/math-magicians.git

cd My-app
npm install
npm start

Prerequisites

In order to run this project you need to:

• Install GIt
• Install Live server VScode extension and run Go Live
• Install a Command Line Interface to clone project-Git bash/Terminal

Setup

Clone this repository

```bash
$ git clone https://github.com/Enoisong/math-magicians.git
$ cd my-app

### Run project
 
#### Open page in browser
```bash
$ runs on http://localhost:3000/

Install

Install this project with:

• VSCode
• Git.
• Github.

Usage

To run the project, execute the following command:

Run tests

To run linters tests, run the following command: npx eslint "/*.{js,jsx}" npx stylelint "/*.{css,scss}"

Deployment

Live on render

(back to top)

👥 Author

• Enobong Isong

👤 Author

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

🔭 Future Features

• [] To add more dynamics to the project - features like transition to make it Responsive

(back to top)

🤝 Contributing

Contributions, issues, as well as feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, give me a ⭐️ star!

(back to top)

🙏 Acknowledgments

• Thanks to the Microverse team for the great curriculum.
• Thanks to the Code Reviewer(s) for the insightly feedbacks.
• A great thanks to my coding partner(s), morning session team and standup team for their contributions.

(back to top)

📝 License

This project is MIT licensed.

(back to top)