Skip to content

Latest commit

 

History

History
87 lines (51 loc) · 3.31 KB

README.md

File metadata and controls

87 lines (51 loc) · 3.31 KB
Raw

Dragons & Dungeons Spells Project

Dragons & Dungeons Spells

Description

Dragons & Dungeons Spells is a web application built using React, Redux Toolkit, TypeScript, React Router, Tailwind CSS, and Jest for test cases. The main objective of this project is to provide users with a comprehensive list of magical spells for the popular role-playing game "Dragons & Dungeons." The application focuses on meeting the following key features:

  1. Display All Spells: The application displays a list of all spells available in the Dragons & Dungeons universe. Users can easily browse through the entire collection.

  2. Spell Details: Users can view detailed information about each spell by clicking on its name or icon. The details page showcases essential attributes such as level, school, casting time, range, and more.

  3. Favorite Spells: To enhance user experience, the application allows users to save spells to a list of favorites. This feature lets users track their preferred spells for quick lookups.

Efforts Addressing Key Points

  • Meeting Challenge Criteria: The project has been developed with a clear focus on meeting the criteria specified, ensuring that all essential features are implemented.

  • UI/UX: Special attention has been given to the application's visual appeal, ensuring an intuitive and ergonomic design. The interface is responsive and works seamlessly on various devices.

  • Code Quality: The project's codebase follows best practices, with a well-organized structure, ensuring readability and maintainability. Components have been thoughtfully divided to enhance code reusability.

  • Functionality: State and lifecycle management have been effectively managed using Redux Toolkit, providing a smooth user experience.

  • Documentation: This README file serves as comprehensive documentation for the project, detailing installation steps, features, technologies used, and more. Additionally, inline comments have been added to the codebase to enhance code understanding.

  • Test Coverage: Jest has been employed to create test cases for the application, ensuring comprehensive test coverage to identify and resolve potential issues.

Technologies Used

  • React
  • Redux Toolkit
  • TypeScript
  • React Router
  • Tailwind CSS
  • Jest (for test cases)

Installation and Setup

Follow these steps to set up the project locally:

  1. Clone the repository to your local machine:

    git clone https://github.com/varun2948/dragons-and-dungeons-spells.git

  2. Navigate to the project directory:

    cd dragons-and-dungeons-spells

  3. Install the project dependencies using Yarn:

    yarn install

Running the Development Server

To start the development server and run the application, use the following command:

yarn run dev

This will launch the development server, and the application will be accessible at http://localhost:3000.

Running Test Cases

To execute the test cases and check for any potential issues, use the following command:

yarn run test

Jest will run the test suite, and you'll get a report of the test results.

License

This project is licensed under the MIT License.

Acknowledgments

Special thanks to the Dragons & Dungeons community for their valuable resources and inspiration.