An open API service indexing awesome lists of open source software.

https://github.com/rysth/react-metrics-app

REACT Metrics App is a web application based on the famous Dungeons and Dragons games, where users can find different classes existing from the original game and also see a list of the most common archetypes for each class. Built with HTML, CSS, JS, and React.
https://github.com/rysth/react-metrics-app

Last synced: about 1 year ago
JSON representation

REACT Metrics App is a web application based on the famous Dungeons and Dragons games, where users can find different classes existing from the original game and also see a list of the most common archetypes for each class. Built with HTML, CSS, JS, and React.

Awesome Lists containing this project

README

          


logo


John Palacios - RysthCraft


# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Commands](#commands)
- [Test](#test)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 REACT Metrics App

- **REACT Metrics App** is a web application based on the famous Dungeons and Dragons games, where users can find different classes existing from the original game and also see a list of the most common archetypes for each class. Built with HTML, CSS, JS, and React.

## 🛠 Built With

### Tech Stack

- ✅ [HTML](https://www.w3schools.com/html/)
- ✅ [CSS](https://www.w3schools.com/css/)
- ✅ [JavaScript](https://www.w3schools.com/js/)
- ✅ [React](https://react.dev/)
- ✅ [Framer Motion Library](https://www.framer.com/motion/)

### Key Features

- 🔰 Display different classes from the Dungeons & Dragons API.
- 🔰 Show details and archetypes about a specific class from the D&D API.
- 🔰 Beautiful animations thanks to Framer Motion Library.

(back to top)

### 🚀 Live Demo

- [Live Demo](https://react-metrics-app-rijy.onrender.com/)

## 💻 Getting Started

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

### Setup

Clone this repository to your desired folder:

```
git clone https://github.com/Rysth/REACT-Metrics-App.git
cd REACT-Metrics-App
code . (To open VS Code Editor)
```

Then, you will change everything you want!

### Commands

- ✔️ _npm start_:
Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

- ✔️ _npm test_:
Launches the test runner in the interactive watch mode. See the section about running tests for more information.

- ✔️ _npm run build_:
Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

### Linters

In order to follow the Linters you could check them using this:

- CSS Checker:

```
npx stylelint "**/*.{css,scss}"
```

- ESLint Checker:

```
npx eslint "**/*.{js,jsx}"
```

_Use at the end '--fix' to help you out with any error._

(back to top)

## 👥 Authors

👤 **John Palacios**

- GitHub: [@rysthcraft](https://github.com/Rysth)
- Linkedin: [@johnpalacios](https://www.linkedin.com/in/john-rysthcraft/)

(back to top)

## 🔭 Future Features

- [ ] Implements Strapi as Headless CMS.
- [ ] Refactor the Code using TailwindCSS.

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project feel free to watch it and take some features that will enhance your project
as well.

(back to top)

## 🙏 Acknowledgments

I would like to thank the Microverse Team for reviewing my code and making me a better
professional.

Thank you so much to [Nelson Sakwa](https://www.behance.net/sakwadesignstudio) for the design provided. Based on the [CC License](https://creativecommons.org/licenses/by-nc/4.0/)

(back to top)

## 📝 License

This project is [MIT](./LICENSE.md) licensed.

(back to top)