Microverse README Template

• 📖 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

Maths Magicians is a Single Page App (SPA) that allows users to perform some basic calculations.

• React

• Create a git flow
• Use functional Component
• Use state and props
• Use destructuring method
• Use routing method
• Test the functionality
• Display quotes from API

(back to top)

• Here is a Live Demo Link

(back to top)

In order to run this project you need:

• git: A tool for managing source code
• Visual Studio Code: A source code editor
• Have a working and updated browser
• Have a local version control like git installed on your computer
• Have an account and sign in on GitHub, as online/remote version control system
• Basic knowledge in JS and React-JS

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

• copy this link.
• get to the directory that you want to clone the repository.
• open the command prompt in this directory.
• write git clone github.com/Donmark2k/maths-magicians.git
• go to the repository folder in your command prompt cd maths-magicians
• write code . to open the project in visual studio code.

To install this project in your local machine use

• Goto the terminal in Visual Studio code by pressing ctrl '
• Install the project dependencies by typing: npm install in the terminal.

To run the project, execute the following command:

• In visual studio terminal type npm start then the project will open on your browser "http://localhost:3000".

• npx stylelint "/*.{css,scss}"**: To test css code
• npx stylelint "**/*.{css,scss}" --fix: To fix some CSS errors if found.
• npx eslint . : To test Eslint Report
• npx eslint . --fix: To fix some JS errors if found

• npm install --save-dev jest
• npm test

You can deploy this project using:

• Netlify

follow these steps for example on how to deploy on netlify

(back to top)

👤Chukwuemeka Ochuba

• GitHub: @Donmark2k
• Twitter: @Donmark2k
• LinkedIn: LinkedIn

(back to top)

• I will add time and date below the nav bar
• I will add a footer

(back to top)

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

Victor Chiemerie has been of tremendous help so far.

• Give a ⭐️ if you like this project!

(back to top)

I would like to appreciate Microverse for providing the resources and the platform for us to be a Professional full-stack developer.

(back to top)

• [Are you sure that you are owner of this work]

  • [Yes]

(back to top)

This project is MIT licensed.

(back to top)