Dungeons and Dragons Toolbox

A Next.js based toolbox for Dungeons and Dragons enthusiasts, designed to streamline game sessions with a suite of interactive tools including dice rolling, character management, and more. This project aims to provide both players and Dungeon Masters with a centralized platform to enhance their gameplay experience.

Technologies Used

• Next.js
• React
• Node.js
• Tailwind CSS

Getting Started

Prerequisites

Ensure you have the following installed:

• Node.js (version 20 or later)
• npm or yarn package manager

Installation

1. Clone the Repository:

   git clone https://github.com/PalmaAnd/Dungeons-and-Dragons-ToolBox.git
   cd Dungeons-and-Dragons-ToolBox

2. Install Dependencies:

   Using npm:

   npm install

   Or with yarn:

   yarn install

3. Run the Development Server:

   Using npm:

   npm run dev

   Or with yarn:

   yarn dev

   Open http://localhost:3000 in your browser to view the project.

Usage

• Navigation: Use the intuitive navigation bar to switch between the dice roller, character manager, spell lookup, and session planner.
• Interactive Tools: Each tool is designed to provide immediate feedback and guidance. Refer to the in-app instructions for detailed usage.
• Customization: Modify settings or the interface to suit your personal gameplay style.

Contributing

Contributions are welcome! If you’d like to help improve this project, please follow these steps:

We welcome contributions from the community! To ensure a smooth collaboration, please follow these guidelines:

1. Fork the Repository: Start by forking the repository to your GitHub account.

2. Create a Branch: Create a new branch for your feature or bug fix. Use a descriptive name for your branch.

   git checkout -b feature/your-feature-name

3. Make Changes: Implement your changes in the new branch. Ensure your code follows the project's coding standards and guidelines.

4. Commit Changes: Commit your changes with clear and concise commit messages.

   git commit -m "Add feature: your feature description"

5. Push Changes: Push your changes to your forked repository.

   git push origin feature/your-feature-name

6. Open a Pull Request: Open a pull request (PR) to the main repository. Provide a detailed description of your changes and the problem they solve.

7. Review and Feedback: Your PR will be reviewed by the project maintainers. Be responsive to feedback and make any necessary changes.

8. Merge: Once your PR is approved, it will be merged into the main repository.

For more details, please see the CONTRIBUTING.md file.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Code of Conduct

Please note that this project has a Code of Conduct. By participating in this project, you agree to abide by its terms.

Questions and Feedback

If you have any questions or feedback about contributing to the project, feel free to reach out to the project maintainer or open a discussion thread in the repository.

Thank you for contributing to Dungeons-and-Dragons-ToolBox and helping make it even better!