Skip to content

An aesthetic board-game encyclopaedia for board-game enthusiasts.

License

Notifications You must be signed in to change notification settings

pauravhp/boardex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BoarDEX

BoarDEX is a dynamic web application designed to explore and compare board games. It provides users with detailed insights, including game descriptions, mechanics, categories, ratings, and reviews. The platform is user-friendly, responsive, and visually engaging, making it a great resource for board game enthusiasts.

🚀 Features

  • Search Board Games: Easily search and filter board games based on their names or categories.
  • View Details: Explore comprehensive details about each board game, including ratings, mechanics, and reviews.
  • Compare Games: Compare different board games side-by-side.
  • Personalized List: Add board games to your personal list for quick reference.
  • User Reviews: Browse reviews from other users.
  • Responsive Design: Fully responsive and optimized for all devices.

🛠️ Technologies Used

  • Frontend: React.js with Material-UI
  • State Management: Redux
  • Routing: React Router
  • Backend/Database: Firebase
  • Styling: SCSS + Material-UI
  • Icons: Material Symbols + FlatIcon
  • Deployment: Netlify

🖱️ How to Use

Search Board Games

  • Use the search bar on the home page to find your favorite board games.

View Details

  • Click on a board game to view its description, mechanics, categories, ratings, and reviews.

Add to List

  • Add board games to your personalized list by clicking the "Add to List" button.

Compare Games

  • Navigate to the "Compare" tab to compare details of two or more board games.

Explore Reviews

  • View detailed reviews and ratings provided by other users.

📚 Libraries, APIs, and Resources

Libraries


APIs

  • BoardGameGeek API: Used to fetch detailed board game data, including descriptions, categories, mechanics, and reviews. BoardGameGeek API
  • Firebase Authentication API: For managing user authentication securely. Firebase Authentication

Resources


📂 Project Structure

boardex/ ├── public/ # Public assets ├── src/ │ ├── app/ # Redux store and slices │ ├── components/ # Reusable components │ ├── pages/ # Application pages (Search, About, Compare, etc.) │ ├── scss/ # SCSS files for styling │ ├── sections/ # Sections like NavBar and Footer │ ├── utils/ # Constants, helper functions, and configurations │ └── index.tsx # Entry point └── README.md # Project documentation

About

An aesthetic board-game encyclopaedia for board-game enthusiasts.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published