Welcome to the fascinating world of Set with Friends, an engaging online multiplayer card game that brings the excitement of the classic game of Set to your screen. This guide will take you through the steps needed to set up the project on your machine, along with instructions for contributing to its ongoing development.

Getting Started: Setting Up the Development Environment

To begin your journey, you’ll need to prepare your development environment. Think of this step as laying the foundation before you start building your fantastic game:

• 1. Install Node.js (version 16) and npm (version 8).
• 2. Globally install the Firebase CLI using the command:

  npm install -g firebase-tools

• 3. Run the following commands in your terminal:

  npm install

  in the root folder and

  npm install

  in the functions folder to get dependencies.

Starting the Project

Now that everything is set up, it’s time to start your project. Running the project is akin to turning on a well-oiled machine:

npm run dev

This command does several important tasks concurrently:

• It builds the TypeScript cloud functions in watch mode.
• It starts the Firebase Local Emulator Suite.
• It launches the frontend using React Fast Refresh.

To monitor everything, access the Emulator UI at http://localhost:4000, where you can observe and modify the database during development.

Contributing to the Project

This game is constantly evolving, and contributions from developers of all backgrounds are more than welcome! It’s like a collaborative art project where everyone’s ideas can come to life:

If you have a new feature idea or want to fix a bug, feel free to voice it on Discord or submit an issue on GitHub. To contribute code:

• Make sure your code follows the formatting rules using Prettier:

  npm run format

• Submit your pull requests to the main branch with your changes.

Deployment Process

Understanding deployment is like preparing for a public showcase of your masterpiece. The game is automatically deployed using GitHub Actions on the main branch, but here’s how to preview your development version:

• To create a build that connects to the local emulator suite, use:

  npm run build:dev

• The staging environment is available at setwithfriends-dev.web.app, where you can see your latest updates live before going to production.

Troubleshooting Tips

If you run into problems while setting up or contributing, don’t worry; troubleshooting is part of the journey! Here are some common issues and ideas to resolve them:

• If you encounter permission issues, ensure you have the right access, particularly when installing packages.
• If the emulator doesn’t start, double-check that all dependencies are installed correctly.
• For problems during deployment, make sure to check the build logs on GitHub Actions for any errors. For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.

Conclusion

By following this guide, you’re stepping into a vibrant community dedicated to coding and gaming. With your contributions, Set with Friends will continue to grow and evolve, providing endless fun for players around the world!