homework-website

Welcome to the repository for the website prototype of HomeworkSMP, our Minecraft SMP server. This project is a work in progress and currently serves as a foundation for our future website.

Project Overview

This website is built using:

• Blazor WebAssembly: A framework for building interactive web applications with .NET.
• TailwindCSS: A utility-first CSS framework for styling.

Features

As of now, we haven't finalized the features that will be included in the website. Stay tuned for updates as we continue to develop and enhance the site.

Prerequisites

Before you begin, ensure you have met the following requirements:

• .NET SDK: You need to have the .NET SDK installed. You can download it from here.
• Node.js and npm: TailwindCSS requires Node.js and npm. You can download them from here.

Recommended IDEs

For a smooth development experience, we recommend using the following Integrated Development Environments (IDEs):

• Visual Studio Code: A lightweight but powerful source code editor. Download it here.
• Visual Studio: An integrated development environment from Microsoft. Download it here.
• JetBrains Rider: A cross-platform .NET IDE. Download it here.

Getting Started

To get started with the project, follow these steps:

1. Clone the repository:

   git clone https://github.com/HomeworkSMP/homework-website.git

2. Navigate to the project directory:

   cd homework-website

3. Install the necessary dependencies and run the project:

   dotnet watch run

Contributing

We welcome contributions! Feel free to open issues or submit pull requests to help improve the project.

Creating a Pull Request

To create a pull request, follow these steps:

1. Fork the repository: Click the "Fork" button at the top right corner of the repository page to create a copy of the repository in your GitHub account.
2. Clone your fork: Clone the forked repository to your local machine.

   git clone https://github.com/your-username/homework-website.git

3. Create a new branch: Create a new branch for your changes.

   git checkout -b feature-branch

4. Make your changes: Make the necessary changes to the codebase.
5. Commit your changes: Commit your changes with a descriptive commit message.

   git commit -m "Description of your changes"

6. Push to your fork: Push the changes to your forked repository.

   git push origin feature-branch

7. Create a pull request: Go to the original repository on GitHub and click the "New Pull Request" button. Select your branch and submit the pull request.

Contact

For any questions or inquiries, please reach out to us through our GitHub repository.

License

This project is licensed under the GPL-3.0 License. See the LICENSE file for more details.