Overview

BoardgamersOpen is a mono-repo for the architecture of boardgamers.space. It consists of a webapp, an admin panel, and backend components. The project requires pnpm as the package manager and a recent version of Node.js (ideally 14+). The webapp can be run directly against the website without the need to run the backend. The backend components can be launched using specific instructions or a provided command. Contributions are welcome, and VS Code is recommended as the editor.

Features

• Webapp and Admin Panel: The project includes a webapp and an admin panel for managing boardgamers.space.
• Frontend and Backend Separation: The webapp can be run independently without the need to run the backend.
• pnpm Package Manager: The project uses pnpm as the package manager, providing efficient and reliable dependency management.
• Node.js Requirement: A recent version of Node.js (14+ ideally) is required to run the project.
• MongoDB Database: The backend components include instructions to launch a MongoDB instance for development purposes.
• Contributions Welcome: The project welcomes contributions from anyone interested in improving it.
• Recommended Editor: VS Code is the recommended editor for working on the project. Its workspace feature allows for easy management of both backend and frontend components.
• Prettier and Gitmoji Extensions: The project recommends installing the Prettier and Gitmoji extensions for better code formatting and commit message conventions.

Installation

To install BoardgamersOpen, follow these steps:

1. Install pnpm:

   # Run this command in your terminal
   npm install -g pnpm
   

2. Install Node.js:

   • Install a recent version of Node.js (preferably 14+) according to your operating system. Instructions can be found on the official Node.js website.

3. Frontend Setup:

   • Create a .env file inside the apps/web folder.
   • Add the following line to the .env file, replacing https://www.boardgamers.space with the appropriate backend URL:

     VITE_backend=https://www.boardgamers.space
     

4. Backend Setup:

   • Follow the instructions in the api-node and game-server folders to set up the backend components.
   • Alternatively, you can run the following command to quickly launch the backend components and a MongoDB instance (for development only):

     # Run this command in your terminal
     docker-compose up
     

     Note: The MongoDB database exposed by this command is not secure and should only be used for development purposes.

5. Editor Setup:

   • Install VS Code: Download and install Visual Studio Code from the official website.
   • Install the recommended extensions: In VS Code, search for and install the “Prettier” and “Gitmoji” extensions.

Summary

BoardgamersOpen is a comprehensive architecture for the boardgamers.space project. It offers a webapp, an admin panel, and backend components. The project requires pnpm as the package manager and Node.js (14+ ideally) for running. The webapp can be directly run against the website, while the backend components can be launched using provided instructions or a single command. Contributions are welcome, and the project recommends using VS Code as the editor, along with the Prettier and Gitmoji extensions for better development experience.