Welcome to the BikeTag Monorepo, the complete platform of software that runs biketag.org. This project brings together various software projects like biketag-api and biketag-vue, alongside the applications and websites that use those previously developed packages.
The BikeTag Project is not just about code; it's about community. Whether you're a developer looking to contribute to the project, a player interested in the mechanics of the game, or simply someone keen on being part of a vibrant, bike-loving community, this monorepo is your gateway. Here, you can dive into the development process, engage in discussions, and help shape the future of BikeTag. We welcome your ideas, feedback, and contributions through GitHub issues and discussions, making this a truly collaborative and evolving project for everyone passionate about biking and gaming.
The BikeTag App is the central hub for players to engage with the BikeTag game in their respective cities. Available as both a mobile app and a web platform via biketag.org, it offers an intuitive and accessible way for players to join games, submit their tags, and interact with the community. This app is the face of BikeTag, providing a seamless and enjoyable IRL gaming experience.
biketag-games is the backbone of the BikeTag game data. It is a sanity.io schema and studio project that manages all game-related data, including locations, tags, and game rules. This project ensures that the game data is structured, consistent, and easily accessible, forming the foundation upon which the BikeTag games operate.
The future roadmap for this project is to have it contained within the biketag-admin as self contained components. Please consider helping out with this project if you have an interest or experience in working with Sanity.io and the BikeTag Project.
biketag-administration is akin to the control room for BikeTag. It's a sanity.io schema and studio project focused on the administrative aspects of the BikeTag ecosystem. This includes managing user roles, overseeing game settings, and ensuring the smooth operation of the platform. It's essential for maintaining the integrity and functionality of the BikeTag games.
The future roadmap for this project is to have it contained within the biketag-admin as self contained components. Please consider helping out with this project if you have an interest or experience in working with Sanity.io and the BikeTag Project.
biketag-api (formerly biketag on npm)
The biketag-api, previously known as biketag on npm, is the API layer that enables interaction with and creation of new BikeTag game data. It's the engine under the hood, processing game actions, storing data, and ensuring that the different components of the BikeTag ecosystem communicate effectively. This API is crucial for developers looking to build on or integrate with the BikeTag platform.
The future roadmap for this project is to implement an AWS source adapter for storing BikeTag Game data Images on AWS. Please consider helping out with this project if you have an interest or experience in working with AWS and the BikeTag Project.
biketag-vue is a comprehensive Vue.js component library and Pinia store tailored for BikeTag applications. It provides a set of reusable Vue components and state management solutions, streamlining the development of BikeTag's user interfaces. This package is invaluable for developers working on Vue.js-based BikeTag applications, offering consistency and efficiency in UI development.
The future roadmap for this project is to convert all components to stateless tailwind styled composables that are fully classed using the BEM css naming convention for easy extensibility.
Similar to biketag-vue, biketag-admin is a Vue.js component library and Pinia store, but it's specifically designed for BikeTag's administrative interfaces. It facilitates the creation of intuitive and effective admin panels and tools, ensuring that administrators can manage the platform effectively. This package is essential for building the administrative side of the BikeTag ecosystem, ensuring a smooth and manageable operation.
This project is actively being redeveloped from code that is currently in the biketag-vue project.
Welcome to the BikeTag Monorepo, a centralized codebase using TurboRepo to manage a constellation of interconnected projects related to the BikeTag game. This guide will walk you through the initial steps of setting up and understanding the monorepo structure, powered by TurboRepo.
TurboRepo is a high-performance build system specifically designed for JavaScript and TypeScript monorepos. It enhances the development experience in a monorepo by offering features like:
- Efficient Caching: TurboRepo caches the output of tasks, reducing build times by avoiding redundant work.
- Task Orchestration: It intelligently runs tasks across various projects in the monorepo, ensuring dependencies are respected.
- Optimized Builds: TurboRepo optimizes build processes by parallelizing tasks wherever possible.
TurboRepo is crucial in the BikeTag Monorepo for managing dependencies across projects and streamlining the development process. For detailed information on TurboRepo and its capabilities, you can refer to TurboRepo documentation.
Start by cloning the BikeTag Monorepo to your local machine using the following commands:
bashCopy code
git clone https://github.com/KenEucker/biketag.git cd biketag
npm install then npm run build
The package.json file in the monorepo contains scripts that are essential for building, testing, and running the projects. Here are some key scripts:
-
build: Runs
turbo run build, which compiles all the projects in the monorepo. TurboRepo ensures that this build process is efficient by utilizing its caching and task orchestration capabilities. For more on the build process in TurboRepo, see their build command documentation. -
dev: Starts the development server for the projects. It's typically used for local development and testing.
-
test: Executes
turbo run test, running tests across all projects in the monorepo. TurboRepo ensures tests are run in an optimized manner, improving the speed and reliability of testing. Check the test command documentation for more details. -
lint: Checks for linting errors across the projects, ensuring code quality and consistency.
These scripts are integral to managing the monorepo's workflow and ensuring that all projects within it are functioning correctly and cohesively.
The BikeTag Monorepo is rich with various projects, each having its own set of documentation. This section aims to guide you through the available resources to help you understand and contribute effectively to the BikeTag projects.
Good documentation is essential for any software project. It helps new and existing contributors understand the architecture, design decisions, and how to get started with development. In the BikeTag Monorepo, each project's documentation serves as an in-depth guide covering its specific functionalities, APIs, and usage instructions. When making changes to the codebases in each project, it is requested that you update the documentation to reflect any updates in functionality or configuration.
- Description: This is the main application for players of the BikeTag game. It allows participation in games, submission of tags, and interaction with other players.
- Documentation: Detailed documentation can be found within the project directory. It includes setup instructions, feature descriptions, and guidelines for contributing to the app development.
- Description: The API layer for interacting with and creating new BikeTag game data. It's integral for developers building on or integrating with the BikeTag platform.
- Documentation: The API documentation provides an overview of the endpoints, data structures, and authentication mechanisms. It's essential for understanding how to interact with the BikeTag backend services.
- Description: A Vue.js component library and Pinia store tailored for BikeTag applications, offering a set of reusable components and state management solutions.
- Documentation: Includes details on the available components, their props, events, and usage examples. It's a valuable resource for developers working with Vue.js in the BikeTag ecosystem.
- Each additional project in the monorepo, like
biketag-gamesandbiketag-administration, comes with its own README and documentation, detailing its purpose, setup, and how to contribute.
- Navigating Documentation: Check the
README.mdfile in each project directory for an introduction and links to more detailed documentation. - Contribution Guides: If you're interested in contributing, look for a
CONTRIBUTING.mdfile in the project directories, which will provide guidelines on how to contribute effectively. - Seeking Help: Use GitHub issues for questions or problems related to a specific project. This can also be a good way to find additional documentation or resources shared by the community.
-
Fork this Repository OR Fork that Repository
- Click on the 'Fork' button to create a copy under your account of this repository to make changes to the monorepo configuration only. Otherwise, you can simply download the contents of this repo and for the individual project you will be submitting changes to. If you're working on the biketag-app project, you would fork that and submit your changes to that repo directly.
-
Clone the Forked Repository
- Clone the forked repository to your local machine:
git clone https://github.com/your-username/biketag-[repo].git
- Clone the forked repository to your local machine:
-
Switch to the
developBranch- Ensure you're working on the most recent
developbranch:git checkout develop
- Ensure you're working on the most recent
-
Make Your Changes
- Modify the code as needed for your contribution.
-
Commit and Push Changes
- Commit your changes with a clear message.
- Push the changes to your fork:
git push origin develop
-
Create a Pull Request
- Go to your fork on GitHub.
- Click 'New Pull Request'.
- Ensure the base repository and branch match the original repository's
developbranch. - Submit the pull request for review.
Prettier is ran and applied automatically as part of a precommit hook, so you don't have to worry about semicolons or trailing commas. Other than that, there are no requirements for how you contribute your code to the BikeTag Project other than following the nature of the code of conduct in your naming and comments.
Contributions you make will go through a review process and the final code that makes it into the codebase is the one that we're all going to be happy with. Thanks!
-
Purpose: It sets expectations for contributions, focusing on respectful and safe interactions within the BikeTag community, both online and at official events.
-
Core Values: Highlights inclusivity, community-driven initiatives, and open collaboration as foundational principles.
-
Expected Behavior: Describes the desired conduct of participants to foster a positive community.
-
Unacceptable Behavior: Defines behaviors that are not tolerated, ensuring a respectful environment.
-
Playing BikeTag: Guidelines specific to playing BikeTag Games using the BikeTag App or on the website biketag.org.
-
Scope: Outlines the extent and applicability of the Code of Conduct.
-
Consequences of Unacceptable Behavior: Details the actions that will be taken in response to violations, including correction, warning, temporary ban, and permanent ban.
-
Reporting Guidelines: Provides instructions on how to report unacceptable behavior.
-
Contact Info: Offers contact information for reporting or inquiries related to the Code of Conduct.
This Code of Conduct is essential for maintaining a respectful, inclusive, and collaborative environment in the BikeTag Project community.
This monorepo project and all BikeTag software projects underneath it are licensed under the GNU AFFERO GENERAL PUBLIC LICENSE.