Skip to content

A mobile app designed to help tabletop gamers keep track of their games.

Notifications You must be signed in to change notification settings

joe-gutman/table-top-tracker

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

TableTop Tracker 🎮

Your central hub for table-top games. 🎲

Overview 📝

TableTop Tracker is a platform designed for board game enthusiasts. It functions as a central hub, allowing users to explore, learn about, and manage their board game collections.

Features:

  • User Authentication: Integrated registration and login system for personalized user experiences.

  • Dashboard Design: Upon login, a dashboard displays the user's personal game collection, facilitating quick access and interaction.

  • Game Discovery:

    • The Game Warden: An AI-powered chatbot designed to recommend board games based on user queries and preferences.
    • Detailed Game Profiles: Each game is represented with a comprehensive page detailing gameplay mechanics, themes, and other relevant information.
  • Collection Management:

    • Customizable Collections: Users can create, edit, and organize their game collections with ease.
    • Easy Game Addition: An interface allows users to add new games to their collections directly from the game's profile.

Getting Started 🚀

Installation & Set-up 💻

  1. Clone the project's repository from GitHub.

    git clone https://github.com/joe-gutman/TableTopTracker
  2. Navigate to the TableTopTracker directory and initiate the app:

    cd TableTopTracker
    npm run start
  3. For the server component, move to the Server directory and start the server:

    cd Server
    npm run server-dev

Running the App 🖥️📱

Web Version: After starting the app, open your browser and visit the displayed local URL.

Mobile Version: Install the "expo go" app on your phone, create an account, and scan the provided QR code after starting the app.

Technical Specifications 🛠️

  • Core Technologies: React Router, React Native, Javascript, PostgreSQL, Node / Express.
  • Integrated APIs: OpenAI, BoardGameGeek, FireBase/FireStore for Authentication.
  • Design & Styling: Leveraged the beauty of React Native Paper and good ol' vanilla CSS.

Contribute

Want to contribute? Fantastic! Please follow our Git Flow 🌊 for best practices.

Git Flow 🌊

  1. Create your own branch 🌿.
  2. Regularly pull from the main branch to remain updated, pull before each push 🔄.
  3. Commit and push your progress, at least after every feature completion ✅.
  4. After submitting a pull request, request a review from at least one other team member before merging into the main branch.

Team 👥

Meet the magicians behind TableTop Tracker:


Happy Gaming! 🎲👾

About

A mobile app designed to help tabletop gamers keep track of their games.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%