Byte Beasts: Official Website 🐉🎮

The official Byte Beasts website

Prerequisites 📋

To be able to run the ByteBeasts website you just need to have Git and node installed. You can install them with the following steps:

Install the repo 🛠️

fork the repo, and clone It to your computer

npm install

npm run dev

Contributing

Thank you for considering contributing to this project! We appreciate your time and effort in improving our work. Below are the guidelines to help you contribute effectively, but first, join to our Telegram contributors group.

1. Fork the Repository

Start by forking this repository to your GitHub account.

2. Clone Your Fork

After forking, clone the repository to your local machine:

   git clone https://github.com/your-user/Website.git
   cd Website

Make sure you are using node v16.20.2

3. Create a New Branch

Create a new branch for your feature or bug fix follwing the branch naming convention:

For bugs: bug-fix-name
For new features: feat-name
For refactor: refactor-name
For docs: docs-name
```
git checkout -b feature-name
```

4. Make Your Changes

Make the necessary changes to the codebase.
Test the webpage to ensure that everything works as expected with your changes

5. Commit Your Changes

Add the changes to the staging area:

   git add .

Commit your changes with a meaningful commit message:

   git commit -m "feat: description"

Example:

   git commit -m "feat: add new character: Tom"

6. Push Your Changes

Push your changes to your forked repository.:

   git push origin branch-name

7. Submit a Pull Request

Once your changes are ready, submit a Pull Request (PR) for review. Ensure that:

Your PR has a clear and descriptive title, please use the same title of the issue
You provide a detailed explanation of the changes made.
You reference any related issues (if applicable).

All contributions must go through the PR review process to maintain code quality and consistency. A project maintainer will review your PR and provide feedback or merge it into the main branch.

Thank you for contributing to ByteBeasts Frontend! If you have any questions, feel free to reach out to the maintainers.