VaheStepanyan100 / metrics-webapp

The React capstone project is a Metrics web application aimed at tracking and analyzing data. It serves as a comprehensive tool for monitoring various metrics, providing users with a user-friendly interface to view and manage data.

📗 Table of Contents

• 📗 Table of Contents
• 📖 [React capstone project - Metrics webapp]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 [React capstone project - Metrics webapp]

[The React capstone project] is a Metrics web application aimed at tracking and analyzing data. It serves as a comprehensive tool for monitoring various metrics, providing users with a user-friendly interface to view and manage data. Built with React as its foundation, the project incorporates modern web development techniques, including Redux for state management, Tailwind CSS for styling, and Styled Components for enhanced component styling. This combination of technologies allows for efficient data tracking, intuitive user interactions, and visually appealing design elements, creating an intuitive and interactive experience for users.

🛠 Built With

Tech Stack

Client

• React.js
• Redux.js
• React Router
• Tailwindcss
• Styled components
• Jest

Key Features

• [Mobile-Friendly Design]
• [Financial Statement Generation]
• [Customization Options]

(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: npm installed in your machine

Setup

Clone this repository to your desired folder:

Example commands:

  cd my-folder
  git clone https://github.com/VaheStepanyan100/matrics-webapp.git

Install

Install this project with:

Example command:

  npm install

Usage

To run the project, execute the following command:

Example command:

  npm start

Run tests

To run tests, run the following command:

Example command:

 npx stylelint "**/*.{css,scss}"
 npx eslint .
 npm test

(back to top)

👥 Authors

👤 Vahe Stepanyan

• GitHub: @VaheStepanyan100
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Implement some UX improvements]
• [Implement additional pages in the website]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank Nelson Sakwa the author of the original design

(back to top)

(back to top)

📝 License

This project is MIT licensed.

(back to top)