Skip to main content
This project is currently a work in progress. There are known issues with consistency, performance, and overall code organization that need to be addressed. The codebase is undergoing active development and cleanup.

​
Welcome

Thank you for your interest in contributing to 5Stack! This platform helps organize and manage competitive CS2 matches and tournaments. Your contributions help make the platform better for everyone.

​
Getting Started

​
Prerequisites

Before you begin, ensure you have the following installed:
  • Node.js (v18 or higher)
  • Yarn (v4.11.0 or higher)
  • Git for version control

​
Setting Up the Development Environment

1

Clone the repository

git clone https://github.com/5stackgg/web.git
cd web
2

Install dependencies

yarn
This will install all required packages and prepare the Nuxt development environment.
3

Start the development server

yarn dev
The development server will start on http://localhost:3000

​
Project Structure

5Stack is built with Nuxt 3 and follows a modular architecture: 
├── components/       # Vue components
│   └── ui/          # UI component library (shadcn-vue)
├── composables/     # Vue composables for shared logic
├── pages/           # File-based routing pages
├── i18n/            # Internationalization files
│   └── locales/     # Translation files
├── assets/          # Static assets and styles
└── scripts/         # Utility scripts

​
Available Scripts

The project includes several helpful scripts: 
yarn dev
# Starts the development server on http://localhost:3000

​
Making Changes

​
Before You Start

  1. Check existing issues - Look for open issues or create a new one to discuss your proposed changes
  2. Create a branch - Use descriptive branch names like feature/add-team-roster or fix/tournament-registration
  3. Follow conventions - Review our code style guide before making changes

​
Development Workflow

1

Make your changes

Write clean, maintainable code following the project’s conventions.
2

Test your changes

  • Test in the development server (yarn dev)
  • Verify your changes work as expected
  • Check for console errors or warnings
3

Check translations

If you added new UI text, ensure translations are properly added:
yarn check-translations
4

Build the project

Ensure the project builds successfully:
yarn build

​
Submitting Changes

​
Pull Request Guidelines

When submitting a pull request:
  1. Provide a clear description - Explain what changes you made and why
  2. Reference issues - Link to any related issues
  3. Include screenshots - For UI changes, include before/after screenshots
  4. Keep it focused - One feature or fix per pull request
  5. Update documentation - Add or update relevant documentation

​
Pull Request Template

## Description
[Briefly describe your changes]

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update

## Related Issues
Closes #[issue number]

## Testing
- [ ] Tested in development environment
- [ ] Build completes without errors
- [ ] Translation checks pass (if applicable)

## Screenshots (if applicable)
[Add screenshots here]

​
Code Review Process

All submissions require review before merging:
  1. A maintainer will review your pull request
  2. Address any requested changes
  3. Once approved, your changes will be merged

​
Need Help?

Documentation

Browse the complete documentation

Code Style Guide

Learn about code conventions

Internationalization

Add translations to the platform

GitHub Issues

Report bugs or request features

​
License

By contributing to 5Stack, you agree that your contributions will be licensed under the same license as the project.

Build docs developers (and LLMs) love

Get started for freeTalk to us