Gmanlove/react-tutorial

📗 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

📖 Math Magicians

Math Magicians "tutoril" 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

Tech Stack

• React using Create React App

Client

• React
• JavaScript(ES6)
• Css
• HTML

Key Features

• Add Components.
• Add Events.
• Fetch data from API.
• Update to become a Full website.
• Tests.
• Deploy.

(back to top)

🚀 Live Demo

Coming soon

(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 to run: npm install

Setup:

Clone this repository to your desired folder:

• cd math-magicians
• git clone git@github.com:Gmanlove/math-magicians.git

Install this project with:

1. Installed Git.
2. Create a local directory that you want to clone the repository.
3. Open the command prompt in the created directory.
4. On the terminal run this command git clone <git@github.com:Gmanlove/math-magicians.git>
5. Run npm i --save-dev to Install the dev dependencies

Usage

To run the project, execute the following command: create-react-app math-magicians npm start

Run tests

To run tests, run the following command: npm test

Deployment

You can deploy this project using: npm run deploy

(back to top)

👥 Authors

👤 Obi Emmanuel

• GitHub: @Gmanlove

(back to top)

🔭 Future Features

• Add Components.
• Add Events.
• Fetch data from API.
• Update to become a Full website.
• Tests.
• Deploy.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to open a Github issues.

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project kindly send to me an e-mail expressing it, it would make my day and fuel my motivation.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse team for this journey.

(back to top)

📝 License

This project is MIT licensed.

(back to top)