Skip to content

BattleBit-Community-Servers/battlebit.community

Repository files navigation

battlebit.community

Overview

BattleBit Community Website is a web application built using Next.js and Bun. This was made for the homepage of battlebit.community.

Installation

Install Bun

First, you'll need to install Bun, a fast JavaScript runtime:

curl -fsSL https://bun.sh/install | bash

After installing, make sure Bun is available in your environment path. You can verify the installation by running:

bun -v

To get started, follow these steps to install and set up the project:

  1. Clone the repository:

    git clone https://github.com/BattleBit-Community-Servers/battlebit.community.git
  2. Navigate into the project directory:

    cd battlebit.community
  3. Install dependencies:

    bun install

    (or specify another package manager if applicable)

  4. Start the application:

    bun run start

    (adjust if different)

Usage

After installation, you can use the project by [brief instructions on how to use or run the project].

Example Usage

Contributing

Contributions are always welcome! If you'd like to contribute, follow these steps:

  1. Fork the repository.
  2. Create a new feature branch (git checkout -b feature-name).
  3. Commit your changes (git commit -m 'Add a new feature').
  4. Push to the branch (git push origin feature-name).
  5. Create a Pull Request.