Boardgamers Mono
Mono-repo for boardgamers.space
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.
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.
- Svelte
Svelte is a modern front-end framework that compiles your code at build time, resulting in smaller and faster applications. It uses a reactive approach to update the DOM, allowing for high performance and a smoother user experience.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.