Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/rvegajr/craptrak


https://github.com/rvegajr/craptrak

Last synced: 10 days ago
JSON representation

Awesome Lists containing this project

README

        

# Dice Roll Tracker

Dice Roll Tracker is a React application designed for tracking the history of dice rolls. It's perfect for board game enthusiasts and anyone who needs to keep track of dice outcomes with the ability to review, select, and remove rolls from the history.

## Features

- Roll two dice and automatically record each roll with a unique history entry.
- Select a roll from the history to highlight and potentially modify it.
- Confirm deletion of rolls with a 'Yes' or 'No' prompt to prevent accidental removal.
- Undo functionality to restore the last deleted roll.
- Responsive design for both desktop and mobile use.

## Prerequisites

Before installation, make sure you have the following prerequisites installed on your system:

- Node.js (v12.0 or higher recommended)
- npm (v6.0 or higher) or Yarn (v1.22 or higher)

## Installation

Clone the repository to your local machine:

```bash
git clone https://github.com/rvegajr/craptrak.git
cd craptrak
```

Install the dependencies:

```bash
npm install
```

Install the dependencies:

```bash
npm install
```
## Running the Application

Start the application in development mode with:
```bash
npm start
```

This will open the application in your default web browser at `http://localhost:3000`.

## Building for Production

To create an optimized production build, use:
```bash
npm run build
```

After running this command, the `build` folder will contain your production-ready build.

## Contributing

Your contributions are what make the open-source community such a fantastic place to learn, inspire, and create. Any contributions you make to CrapTrak are **greatly appreciated**.

1. Fork the project.
2. Create your feature branch (`git checkout -b feature/AmazingFeature`).
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`).
4. Push to the branch (`git push origin feature/AmazingFeature`).
5. Open a pull request.

## License

Distributed under the MIT License. See `LICENSE` for more information.

## Contact

- Project Link: [https://github.com/rvegajr/craptrak](https://github.com/rvegajr/craptrak)

## Acknowledgements

- [Font Awesome](https://fontawesome.com) for providing the dice icons.
- [React](https://reactjs.org/) for the framework to build this application.