Skip to content

Website to enable Civilization VI players to draft before their game

License

Notifications You must be signed in to change notification settings

leovalette/civdraft

Repository files navigation

Civdraft

Civdraft Description

Civdraft is a collaborative web application for managing and drafting leaders and maps in Civilization VI. The platform enables players to participate in organized draft sessions where they can select civilizations, leaders, and maps in real-time. It supports team-based gameplay with features like lobbies, chat functionality, timers, and draft tracking. The application is designed to facilitate fair and engaging multiplayer game preparation with admin capabilities for managing presets and bans.

Technologies

Frontend:

Backend & Database:

Authentication:

Development & Tooling:

Getting Started

Prerequisites

  • Node.js (v18 or higher recommended)
  • pnpm

Installation & Development

  1. Clone the repository:
git clone git@github.com:leovalette/civdraft.git
cd civdraft
  1. Install dependencies:
pnpm install
  1. Set up environment variables (ask project maintainers for .env.local):
# Create .env.local with necessary keys for Clerk and Convex. ASK FOR THEM TO THE CODEOWNER
  1. Run the development server:
pnpm dev
  1. Open http://localhost:3000 in your browser to see the application.

Build for Production

pnpm build
pnpm start

Code Quality

Lint and format code:

pnpm lint
pnpm format

How to Contribute

We welcome contributions to Civdraft! Here's how you can help:

Getting Started with Contributing

  1. Clone the repository on GitHub
  2. Create a feature branch for your changes:
    git checkout -b feature/your-feature-name
  3. Make your changes and commit with clear, descriptive messages:
    git commit -m "Add description of changes"
  4. Ensure code quality:
    • Run pnpm format to format your code
  5. Push to your fork and create a Pull Request against the main branch
  6. Describe your changes in the PR description, including:
    • What problem does it solve?
    • How does it work?
    • Any breaking changes?

Development Guidelines

  • Follow the existing code style and project structure
  • Use TypeScript for type safety
  • Write clear, descriptive commit messages
  • Test your changes before submitting a PR
  • Keep PRs focused on a single feature or bug fix

Areas to Contribute

  • Bug fixes and issue resolutions
  • UI/UX improvements
  • Performance optimizations
  • Documentation improvements
  • New features and game modes
  • Testing

Questions?

If you have questions about contributing, feel free to open an issue or discuss in the project's issue tracker.


License: See LICENSE file for details.

About

Website to enable Civilization VI players to draft before their game

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors