math_magicians
math_magicians copied to clipboard
"Math_Magicians" showcases my web development skills in `React` and `UI/UX` design. It demonstrates my ability to create engaging interfaces through wireframing, component creation, event handling, an...
math_magicians
📗 Table of Contents
- 📗 Table of Contents
-
📖 math_magicians
-
🛠 Built With
- Tech Stack
- Key Features
- 🚀 Live Demo
-
💻 Getting Started
- Project Structure
- Setup
- Install
- Usage
- Run tests
- 👥 Authors
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgments
- 📝 License
-
🛠 Built With
📖 math_magicians
"math_magicians" is a project that allows me to showcase my web development skills and expertise in React and UI/UX design. With a focus on engaging interfaces, I demonstrate proficiency in various aspects including wireframing, component creation, event handling, and API integration. The project embodies intuitive design principles and seamless functionality, delivering a captivating user experience.
🛠 Built With
Tech Stack
React
- This project use React
HTML
- This project use HTML.
CSS
- The CSS is used to provide the design in the whole page.
Linters
- The Linters are tools that help us to check and solve the errors in the code This project count with three linters:
- CSS
- JavaScript
Key Features
- React configuration
- HTML Generation
- CSS Styling
- Development Server
- Code Quality
- Modular Structure
- JavaScript Functionality
- Gitflow
(back to top)
🚀 Live Demo
You can see a Demo here: Demo
(back to top)
💻 Getting Started
To get a local copy up and running, follow these steps. This project requires Node.js and npm installed on your machine.
-Node.js -npm
-Clone this repository to your local machine using:
git clone https://github.com/ClaudiaRojasSoto/math_magicians.git
-Navigate to the project folder:
cd math_magicians
-Install the project dependencies:
npm install
To start the development server, run the following command:
npm start
Project Structure
The project follows the following folder and file structure:
- /src: Contains the source files of the application.
- /src/index.js: Main entry point of the JavaScript application.
- /src/App.js: Top-level component of the application.
- /src/components: Directory for React components.
- /src/components/Calculator.js: React component for the calculator.
- /src/calculator.css: CSS file for the Calculator.js styles.
- /src/App.css: CSS file for the App.js styles.
- /src/index.css: CSS file for the index.js styles.
- /public: Contains the public files and assets of the application.
- /public/index.html: Base HTML file of the application.
- /build: Contains the generated production files.
Setup
Clone this repository to your desired folder: https://github.com/ClaudiaRojasSoto/math_magicians.git
Install
Install this project with: install Stylelint and ESLint
Usage
To run the project, execute the following command: just need a web Browser
Run tests
To run tests, run the following command: npm start you just need a simple web browser to run this project for a test
👥 Authors
👤 Claudia Rojas
- GitHub: @githubhandle
- LinkedIn: LinkedIn
(back to top)
🔭 Future Features
- Testing
(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 show support by following this account
(back to top)
🙏 Acknowledgments
- Microverse for providing the opportunity to learn Git and GitHub in a collaborative environment.
- GitHub Docs for providing a wealth of information on Git and GitHub.
(back to top)
📝 License
This project is MIT.
(back to top)